Azure Communication Services - Telephony and SMS events
This article provides the properties and schema for communication services telephony and SMS events. For an introduction to event schemas, see Azure Event Grid event schema.
Events types
Azure Communication Services emits the following telephony and SMS event types:
Event type | Description |
---|---|
Microsoft.Communication.SMSReceived | Published when an SMS is received by a phone number associated with the Communication Service. |
Microsoft.Communication.SMSDeliveryReportReceived | Published when a delivery report is received for an SMS sent by the Communication Service. |
Event responses
When an event is triggered, the Event Grid service sends data about that event to subscribing endpoints.
This section contains an example of what that data would look like for each event.
Microsoft.Communication.SMSDeliveryReportReceived event
[{
"id": "Outgoing_202009180022138813a09b-0cbf-4304-9b03-1546683bb910",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/microsoft.communication/communicationservices/{communication-services-resource-name}",
"subject": "/phonenumber/15555555555",
"data": {
"MessageId": "Outgoing_202009180022138813a09b-0cbf-4304-9b03-1546683bb910",
"From": "15555555555",
"To": "+15555555555",
"DeliveryStatus": "Delivered",
"DeliveryStatusDetails": "No error.",
"ReceivedTimestamp": "2020-09-18T00:22:20.2855749Z",
"DeliveryAttempts": [
{
"Timestamp": "2020-09-18T00:22:14.9315918Z",
"SegmentsSucceeded": 1,
"SegmentsFailed": 0
}
],
"Tag": "Optional customer-tag set in the original message"
},
"eventType": "Microsoft.Communication.SMSDeliveryReportReceived",
"dataVersion": "1.0",
"metadataVersion": "1",
"eventTime": "2020-09-18T00:22:20Z"
}]
Note
Possible values for DeliveryStatus
are Delivered
and Failed
.
Microsoft.Communication.SMSReceived event
[{
"id": "Incoming_20200918002745d29ebbea-3341-4466-9690-0a03af35228e",
"topic": "/subscriptions/50ad1522-5c2c-4d9a-a6c8-67c11ecb75b8/resourcegroups/acse2e/providers/microsoft.communication/communicationservices/{communication-services-resource-name}",
"subject": "/phonenumber/15555555555",
"data": {
"MessageId": "Incoming_20200918002745d29ebbea-3341-4466-9690-0a03af35228e",
"From": "15555555555",
"To": "15555555555",
"Message": "Great to connect with Azure Communication Services events",
"ReceivedTimestamp": "2020-09-18T00:27:45.32Z"
},
"eventType": "Microsoft.Communication.SMSReceived",
"dataVersion": "1.0",
"metadataVersion": "1",
"eventTime": "2020-09-18T00:27:47Z"
}]
Next steps
See the following tutorial:Quickstart: Handle SMS and delivery report events.
Povratne informacije
https://aka.ms/ContentUserFeedback.
Stiže uskoro: Tijekom 2024. postupno ćemo ukinuti servis Problemi sa servisom GitHub kao mehanizam za povratne informacije za sadržaj i zamijeniti ga novim sustavom za povratne informacije. Dodatne informacije potražite u članku:Pošaljite i pogledajte povratne informacije za