Skip to content

Commit 97559f6

Browse files
author
Kirill Linnik
committed
ACS SMS, removing/adjusting message ID examples and asking customers not to build their logic on top of that
1 parent 6c89855 commit 97559f6

File tree

9 files changed

+28
-26
lines changed

9 files changed

+28
-26
lines changed

articles/communication-services/concepts/analytics/logs/sms-logs.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,9 @@ Communication Services offers the following types of logs:
8989
| `SdkType` | The SDK type used in the request. |
9090
| `PlatformType` | The platform type used in the request. |
9191
| `Method` | The method used in the request. |
92-
|`NumberType`| The type of number, the SMS message is being sent from. It can be either **LongCodeNumber**, **ShortCodeNumber**, or **DynamicAlphaSenderID**.|
93-
|`MessageID`| Represents the unique messageId generated for every outgoing and incoming message. Find the MessageId in the SMS API response object. |
94-
|`Country`| Represents the countries/regions where SMS messages are sent to or received from. |
92+
| `NumberType` | The type of number, the SMS message is being sent from. It can be either **LongCodeNumber**, **ShortCodeNumber**, or **DynamicAlphaSenderID**.|
93+
| `MessageID` | Represents the unique message ID generated for every outgoing and incoming message. Find the MessageId in the SMS API response object. The format of message ID returned by this API is considered an internal implementation detail and is subject to change without notice. Clients must treat message ID as opaque identifiers and must not parse, infer structure, or build logic based on their format or content.|
94+
| `Country` | Represents the countries/regions where SMS messages are sent to or received from. |
9595

9696
#### Example SMS sent log
9797

@@ -118,7 +118,7 @@ Communication Services offers the following types of logs:
118118
"SdkType": "azsdk-net-Communication.Sms",
119119
"PlatformType": "Microsoft Windows 10.0.17763",
120120
"Method": "POST",
121-
"MessageId": "Outgoing_20230118181300ff00e5c9-876d-4958-86e3-4637484fe5bd_noam",
121+
"MessageId": "ff00e5c9-876d-4958-86e3-4637484fe5bd",
122122
"Country": "US"
123123
}
124124
]
@@ -149,7 +149,7 @@ Communication Services offers the following types of logs:
149149
"SdkType": "",
150150
"PlatformType": "",
151151
"Method": "POST",
152-
"MessageId": "Outgoing_20230118181300ff00e5c9-876d-4958-86e3-4637484fe5bd_noam",
152+
"MessageId": "ff00e5c9-876d-4958-86e3-4637484fe5bd",
153153
"Country": "US"
154154
}
155155
]
@@ -180,7 +180,7 @@ Communication Services offers the following types of logs:
180180
"SdkType": "",
181181
"PlatformType": "",
182182
"Method": "POST",
183-
"MessageId": "Incoming_2023011818121211c6ee31-63fe-477c-8d51-f800543c6694",
183+
"MessageId": "11c6ee31-63fe-477c-8d51-f800543c6694",
184184
"Country": "US"
185185
}
186186
]
@@ -189,4 +189,4 @@ Communication Services offers the following types of logs:
189189

190190
## Related articles
191191

192-
[SMS FAQ](/azure/azure-monitor/overview#frequently-asked-questions)
192+
[SMS FAQ](/azure/azure-monitor/overview#frequently-asked-questions)

articles/communication-services/how-tos/event-grid/local-testing-event-grid.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,11 @@ http://localhost:7071/runtime/webhooks/EventGrid?functionName={functionname}
4848
```json
4949

5050
{
51-
"id": "Incoming_20200918002745d29ebbea-3341-4466-9690-0a03af35228e",
51+
"id": "d29ebbea-3341-4466-9690-0a03af35228e",
5252
"topic": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/acse2e/providers/microsoft.communication/communicationservices/{communication-services-resource-name}",
5353
"subject": "/phonenumber/15555555555",
5454
"data": {
55-
"MessageId": "Incoming_20200918002745d29ebbea-3341-4466-9690-0a03af35228e",
55+
"MessageId": "d29ebbea-3341-4466-9690-0a03af35228e",
5656
"From": "15555555555",
5757
"To": "15555555555",
5858
"Message": "Great to connect with Azure Communication Services events",
@@ -79,4 +79,4 @@ http://localhost:7071/runtime/webhooks/EventGrid?functionName={functionname}
7979

8080
![Screenshot of Postman send button.](media/postman-send.png)
8181

82-
At this point, an event should trigger in your Azure Function. You can verify the event by looking at the execution of your Azure Function. You can then validate that the function is doing its job correctly.
82+
At this point, an event should trigger in your Azure Function. You can verify the event by looking at the execution of your Azure Function. You can then validate that the function is doing its job correctly.
12.4 KB
Loading

articles/communication-services/quickstarts/identity/includes/active-directory/service-principal-java.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,6 @@ The final output should resemble the following:
201201
Retrieving new Access Token, using Service Principals
202202
Retrieved Access Token: ey..A
203203
Sending SMS using using Service Principals
204-
Sms id: Outgoing_202104...33f8ae1f_noam
204+
Sms id: ...
205205
Send Result Successful: true
206206
```

articles/communication-services/quickstarts/identity/includes/active-directory/service-principal-js.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,6 @@ With everything complete, you can run the file by entering `node index.js` from
158158
Retrieving new Access Token, using Service Principals
159159
Retrieved Access Token: ey...Q
160160
Sending SMS using Service Principals
161-
SMS ID: Outgoing_2021040602194...._noam
161+
SMS ID: ...
162162
Send Result Successful: true
163-
```
163+
```

articles/communication-services/quickstarts/identity/includes/active-directory/service-principal-net.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,6 @@ You should now be able to run your application, using `dotnet run` from your app
161161
Retrieving new Access Token, using Service Principals
162162
Retrieved Access Token: ey....
163163
Sending SMS using Service Principals
164-
Sms id: Outgoing_..._noam
164+
Sms id: ...
165165
Send Result Successful: True
166-
```
166+
```

articles/communication-services/quickstarts/identity/includes/active-directory/service-principal-python.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,6 @@ With everything complete, you can run the file by entering `python authenticatio
138138
Retrieving new Access Token, using Service Principals
139139
Retrieved Access Token: ey...Q
140140
Sending SMS using using Service Principals
141-
SMS ID: Outgoing_2021040602194...._noam
141+
SMS ID: ...
142142
Send Result Successful: true
143-
```
143+
```

articles/communication-services/quickstarts/sms/receive-sms.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ The `SMSReceived` event generated when an SMS is sent to an Azure Communication
2626

2727
```json
2828
[{
29-
"id": "Incoming_20200918002745d29ebbea-3341-4466-9690-0a03af35228e",
29+
"id": "d29ebbea-3341-4466-9690-0a03af35228e",
3030
"topic": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/acse2e/providers/microsoft.communication/communicationservices/{communication-services-resource-name}",
3131
"subject": "/phonenumber/15555555555",
3232
"data": {
33-
"MessageId": "Incoming_20200918002745d29ebbea-3341-4466-9690-0a03af35228e",
33+
"MessageId": "d29ebbea-3341-4466-9690-0a03af35228e",
3434
"From": "15555555555",
3535
"To": "15555555555",
3636
"Message": "Great to connect with Azure Communication Services events",
@@ -42,6 +42,8 @@ The `SMSReceived` event generated when an SMS is sent to an Azure Communication
4242
"eventTime": "2020-09-18T00:27:47Z"
4343
}]
4444
```
45+
> [!NOTE]
46+
> The format of `MessageId` returned by this API is considered an internal implementation detail and is subject to change without notice. Clients must treat message IDs as opaque identifiers and must not parse, infer structure, or build logic based on their format or content.
4547
4648
To start generating events, configure Azure Event Grid to use your Azure Communication Services resource.
4749

@@ -80,4 +82,4 @@ If you have a new toll-free number and want to send a [high volume of SMS messag
8082
> [Phone number types](../../concepts/telephony/plan-solution.md)
8183
8284
> [!div class="nextstepaction"]
83-
> [Learn more about SMS](../../concepts/sms/concepts.md)
85+
> [Learn more about SMS](../../concepts/sms/concepts.md)

articles/event-grid/communication-services-telephony-sms-events.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.author: vikramdh
99

1010
# Azure Communication Services - SMS events
1111

12-
This article provides the properties and schema for communication services SMS events. For an introduction to event schemas, see [Azure Event Grid event schema](event-schema.md).
12+
This article provides the properties and schema for communication services SMS events. For an introduction to event schemas, see [Azure Event Grid event schema](event-schema.md).
1313

1414
## Events types
1515

@@ -30,11 +30,11 @@ This section contains an example of what that data would look like for each even
3030

3131
```json
3232
[{
33-
"id": "Outgoing_202009180022138813a09b-0cbf-4304-9b03-1546683bb910",
33+
"id": "8813a09b-0cbf-4304-9b03-1546683bb910",
3434
"topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/microsoft.communication/communicationservices/{communication-services-resource-name}",
3535
"subject": "/phonenumber/15555555555",
3636
"data": {
37-
"messageId": "Outgoing_202009180022138813a09b-0cbf-4304-9b03-1546683bb910",
37+
"messageId": "8813a09b-0cbf-4304-9b03-1546683bb910",
3838
"from": "15555555555",
3939
"to": "+15555555555",
4040
"deliveryStatus": "Delivered",
@@ -63,11 +63,11 @@ This section contains an example of what that data would look like for each even
6363

6464
```json
6565
[{
66-
"id": "Incoming_20200918002745d29ebbea-3341-4466-9690-0a03af35228e",
66+
"id": "d29ebbea-3341-4466-9690-0a03af35228e",
6767
"topic": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/acse2e/providers/microsoft.communication/communicationservices/{communication-services-resource-name}",
6868
"subject": "/phonenumber/15555555555",
6969
"data": {
70-
"messageId": "Incoming_20200918002745d29ebbea-3341-4466-9690-0a03af35228e",
70+
"messageId": "d29ebbea-3341-4466-9690-0a03af35228e",
7171
"from": "15555555555",
7272
"to": "15555555555",
7373
"message": "Great to connect with Azure Communication Services events",
@@ -82,4 +82,4 @@ This section contains an example of what that data would look like for each even
8282
```
8383

8484
## Next steps
85-
See the following tutorial:[Quickstart: Handle SMS and delivery report events](../communication-services/quickstarts/sms/handle-sms-events.md).
85+
See the following tutorial:[Quickstart: Handle SMS and delivery report events](../communication-services/quickstarts/sms/handle-sms-events.md).

0 commit comments

Comments
 (0)