Communications - List
Lists all communications (attachments not included) for a support ticket.
You can also filter support ticket communications by CreatedDate or CommunicationType using the $filter parameter. The only type of communication supported today is Web. Output will be a paged result with nextLink, using which you can retrieve the next set of Communication results.
Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications?api-version=2022-09-01-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications?$top={$top}&$filter={$filter}&api-version=2022-09-01-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
Azure subscription Id. |
support
|
path | True |
string |
Support ticket name. |
api-version
|
query | True |
string |
API version. |
$filter
|
query |
string |
The filter to apply on the operation. You can filter by communicationType and createdDate properties. CommunicationType supports Equals ('eq') operator and createdDate supports Greater Than ('gt') and Greater Than or Equals ('ge') operators. You may combine the CommunicationType and CreatedDate filters by Logical And ('and') operator. |
|
$top
|
query |
integer int32 |
The number of values to return in the collection. Default is 10 and max is 10. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Successfully retrieved communications for a support ticket. |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
List communications for a subscription support ticket
Sample Request
GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket/communications?api-version=2022-09-01-preview
Sample Response
{
"value": [
{
"id": "/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket/communications/testmessage1",
"name": "testmessage1",
"type": "Microsoft.Support/communications",
"properties": {
"subject": "this is a test message",
"body": "this is a test message",
"communicationType": "web",
"communicationDirection": "outbound",
"sender": "user@contoso.com",
"createdDate": "2020-03-24T20:18:19Z"
}
},
{
"id": "/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket/communications/testmessage2",
"name": "testmessage2",
"type": "Microsoft.Support/communications",
"properties": {
"subject": "test",
"body": "test",
"communicationType": "web",
"communicationDirection": "outbound",
"sender": "user@contoso.com",
"createdDate": "2020-03-29T10:53:19Z"
}
}
]
}
List web communication created on or after a specific date for a subscription support ticket
Sample Request
GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket/communications?$filter=communicationType eq 'web' and createdDate ge 2020-03-10T22:08:51Z&api-version=2022-09-01-preview
Sample Response
{
"value": [
{
"id": "/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket/communications/testmessage1",
"name": "testmessage1",
"type": "Microsoft.Support/communications",
"properties": {
"subject": "this is a test message",
"body": "this is a test message",
"communicationType": "web",
"communicationDirection": "outbound",
"sender": "user@contoso.com",
"createdDate": "2020-03-11T20:18:19Z"
}
},
{
"id": "/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket/communications/testmessage2",
"name": "testmessage2",
"type": "Microsoft.Support/communications",
"properties": {
"subject": "test",
"body": "test",
"communicationType": "web",
"communicationDirection": "outbound",
"sender": "user@contoso.com",
"createdDate": "2020-03-12T10:53:19Z"
}
}
]
}
List web communications for a subscription support ticket
Sample Request
GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket/communications?$filter=communicationType eq 'web'&api-version=2022-09-01-preview
Sample Response
{
"value": [
{
"id": "/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket/communications/testmessage1",
"name": "testmessage1",
"type": "Microsoft.Support/communications",
"properties": {
"subject": "this is a test message",
"body": "this is a test message",
"communicationType": "web",
"communicationDirection": "outbound",
"sender": "user@contoso.com",
"createdDate": "2020-03-10T20:18:19Z"
}
},
{
"id": "/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket/communications/testmessage2",
"name": "testmessage2",
"type": "Microsoft.Support/communications",
"properties": {
"subject": "test",
"body": "test",
"communicationType": "web",
"communicationDirection": "outbound",
"sender": "user@contoso.com",
"createdDate": "2020-03-11T10:53:19Z"
}
}
]
}
Definitions
Name | Description |
---|---|
Communication |
Object that represents a Communication resource. |
Communication |
Direction of communication. |
Communications |
Collection of Communication resources. |
Communication |
Communication type. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
CommunicationDetails
Object that represents a Communication resource.
Name | Type | Description |
---|---|---|
id |
string |
Id of the resource. |
name |
string |
Name of the resource. |
properties.body |
string |
Body of the communication. |
properties.communicationDirection |
Direction of communication. |
|
properties.communicationType |
Communication type. |
|
properties.createdDate |
string |
Time in UTC (ISO 8601 format) when the communication was created. |
properties.sender |
string |
Email address of the sender. This property is required if called by a service principal. |
properties.subject |
string |
Subject of the communication. |
type |
string |
Type of the resource 'Microsoft.Support/communications'. |
CommunicationDirection
Direction of communication.
Name | Type | Description |
---|---|---|
inbound |
string |
|
outbound |
string |
CommunicationsListResult
Collection of Communication resources.
Name | Type | Description |
---|---|---|
nextLink |
string |
The URI to fetch the next page of Communication resources. |
value |
List of Communication resources. |
CommunicationType
Communication type.
Name | Type | Description |
---|---|---|
phone |
string |
|
web |
string |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |