Azure Communication Services REST API

https://learn.microsoft.com/en-us/rest/api/communication/
Admin
Azure Communication Services REST API provides programmatic access to add real-time voice, video,...
Tokens:184,348
Snippets:969
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Download Media Example

Source: https://learn.microsoft.com/en-us/rest/api/communication/advancedmessaging/stream-operations/get-media

A concrete example of a GET request to download media and the corresponding binary response.

```HTTP
GET https://my-resource.communication.azure.com/messages/streams/d19e68ec-bdd6-4a50-8dfb-cbb1642df6ab?api-version=2024-08-30
```

```JSON
"<binary_media_data>"
```

--------------------------------

### Get Assignment Example

Source: https://learn.microsoft.com/en-us/rest/api/communication/identity/teams-extension-assignment/get

A concrete example of a request and its corresponding successful JSON response.

```HTTP
GET https://my-resource.communication.azure.com/access/teamsExtension/tenants/c70d068c-2f32-484d-9455-73070cd5aadd/assignments/b27b64b9-39d2-44a3-869d-67700b74e805?api-version=2025-03-02-preview
```

```JSON
{
  "objectId": "b27b64b9-39d2-44a3-869d-67700b74e805",
  "tenantId": "c70d068c-2f32-484d-9455-73070cd5aadd",
  "principalType": "resourceAccount"
}
```

--------------------------------

### Get Job Position Example

Source: https://learn.microsoft.com/en-us/rest/api/communication/jobrouter/job-router-operations/get-in-queue-position

A concrete example of a request and its corresponding successful response.

```HTTP
GET https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958/position?api-version=2023-11-01
```

```JSON
{
  "jobId": "383541b3-5637-4af6-8aac-3391da8a578a",
  "position": 1,
  "queueId": "MainQueue",
  "queueLength": 3,
  "estimatedWaitTimeMinutes": 4
}
```

--------------------------------

### List all rooms sample request

Source: https://learn.microsoft.com/en-us/rest/api/communication/rooms/rooms/list

An example of a fully qualified HTTP GET request to list rooms.

```HTTP
GET https://contoso.communication.azure.com//rooms?api-version=2025-03-13
```

--------------------------------

### Get Message Status Example

Source: https://learn.microsoft.com/en-us/rest/api/communication/email/email/get-send-status

A concrete example of a GET request to retrieve the status of a specific email message.

```HTTP
GET https://contoso.westus.communications.azure.com/emails/F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4/status?api-version=2021-10-01-preview
```

--------------------------------

### Start Media Streaming Request Example

Source: https://learn.microsoft.com/en-us/rest/api/communication/callautomation/call-media/start-media-streaming

A sample request demonstrating the POST call to the media streaming endpoint.

```HTTP
POST https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c:startMediaStreaming?api-version=2026-03-12

{}
```

--------------------------------

### Start Reservation Purchase Response Example

Source: https://learn.microsoft.com/en-us/rest/api/communication/phonenumbers/phone-numbers/purchase-reservation

A sample HTTP response indicating the request was accepted, providing the operation location and IDs for tracking.

```HTTP
Operation-Location: https://resourcename.communication.azure.comoperations/reservationPurchase_65c18c7f-8074-4efb-a572-e0df127a9964?api-version=2023-11-01-preview
operation-id: reservationPurchase_65c18c7f-8074-4efb-a572-e0df127a9964
reservation-purchase_id: 65c18c7f-8074-4efb-a572-e0df127a9964
```

--------------------------------

### Get Assignment Sample Request

Source: https://learn.microsoft.com/en-us/rest/api/communication/identity/teams-extension-operations/get-assignment

A concrete example of a GET request to retrieve an assignment for a specific tenant and object ID.

```HTTP
GET https://my-resource.communication.azure.com/access/teamsExtension/tenants/c70d068c-2f32-484d-9455-73070cd5aadd/assignments/b27b64b9-39d2-44a3-869d-67700b74e805?api-version=2025-06-30
```

--------------------------------

### CallMedia_StartTranscription Sample Request

Source: https://learn.microsoft.com/en-us/rest/api/communication/callautomation/call-media/start-transcription

A concrete example of a POST request to start transcription for a specific call connection ID.

```HTTP
POST https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c:startTranscription?api-version=2026-03-12

{}
```

--------------------------------

### Get Message Status SuccessTerminalStatus Examples

Source: https://learn.microsoft.com/en-us/rest/api/communication/email/email/get-send-result

Request and response examples for a successfully completed email operation.

```HTTP
GET https://contoso.westus.communications.azure.com/emails/operations/F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4?api-version=2025-09-01
```

```JSON
{
  "id": "F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4",
  "status": "Succeeded"
}
```

--------------------------------

### Sample Request and Response

Source: https://learn.microsoft.com/en-us/rest/api/communication/rooms/rooms/get-participants

Example of a concrete GET request and the corresponding JSON response containing participant details.

```HTTP
GET https://contoso.communication.azure.com//rooms/99199690362660524/participants?api-version=2022-02-01
```

```JSON
{
  "participants": [
    {
      "communicationIdentifier": {
        "rawId": "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000333",
        "communicationUser": {
          "id": "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000333"
        }
      },
      "role": "Presenter"
    },
    {
      "communicationIdentifier": {
        "rawId": "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000444",
        "communicationUser": {
          "id": "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000444"
        }
      },
      "role": "Attendee"
    },
    {
      "communicationIdentifier": {
        "rawId": "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000555",
        "communicationUser": {
          "id": "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000555"
        }
      },
      "role": "Attendee"
    }
  ]
}
```

--------------------------------

### Link Notification Hub Examples

Source: https://learn.microsoft.com/en-us/rest/api/communication/resourcemanager/communication-service/link-notification-hub

Examples demonstrating how to link a notification hub using HTTP, Java, and Go.

```HTTP
POST https://management.azure.com/subscriptions/12345/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/communicationServices/MyCommunicationResource/linkNotificationHub?api-version=2020-08-20

{
  "resourceId": "/subscriptions/12345/resourceGroups/MyOtherResourceGroup/providers/Microsoft.NotificationHubs/namespaces/MyNamespace/notificationHubs/MyHub",
  "connectionString": "Endpoint=sb://MyNamespace.servicebus.windows.net/;SharedAccessKey=abcd1234"
}
```

```Java
import com.azure.core.util.Context;
import com.azure.resourcemanager.communication.models.LinkNotificationHubParameters;

/** Samples for CommunicationService LinkNotificationHub. */
public final class Main {
    /*
     * x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/linkNotificationHub.json
     */
    /**
     * Sample code: Link notification hub.
     *
     * @param manager Entry point to CommunicationManager.
     */
    public static void linkNotificationHub(com.azure.resourcemanager.communication.CommunicationManager manager) {
        manager
            .communicationServices()
            .linkNotificationHubWithResponse(
                "MyResourceGroup",
                "MyCommunicationResource",
                new LinkNotificationHubParameters()
                    .withResourceId(
                        "/subscriptions/12345/resourceGroups/MyOtherResourceGroup/providers/Microsoft.NotificationHubs/namespaces/MyNamespace/notificationHubs/MyHub")
                    .withConnectionString("Endpoint=sb://MyNamespace.servicebus.windows.net/;SharedAccessKey=abcd1234"),
                Context.NONE);
    }
}
```

```Go
package armcommunication_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/communication/armcommunication"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/linkNotificationHub.json
func ExampleServiceClient_LinkNotificationHub() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armcommunication.NewServiceClient("12345", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.LinkNotificationHub(ctx,
		"MyResourceGroup",
		"MyCommunicationResource",
		&armcommunication.ServiceClientLinkNotificationHubOptions{LinkNotificationHubParameters: &armcommunication.LinkNotificationHubParameters{
			ConnectionString: to.Ptr("Endpoint=sb://MyNamespace.servicebus.windows.net/;SharedAccessKey=abcd1234"),
			ResourceID:       to.Ptr("/subscriptions/12345/resourceGroups/MyOtherResourceGroup/providers/Microsoft.NotificationHubs/namespaces/MyNamespace/notificationHubs/MyHub"),
		},
		})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
```

--------------------------------

### Start Reservation Purchase Request Example

Source: https://learn.microsoft.com/en-us/rest/api/communication/phonenumbers/phone-numbers/purchase-reservation

A sample HTTP request to purchase phone numbers for a specific reservation ID.

```HTTP
POST https://resourcename.communication.azure.com/availablePhoneNumbers/reservations/65c18c7f-8074-4efb-a572-e0df127a9964/:purchase?api-version=2025-06-01
```

--------------------------------

### Get participants sample request

Source: https://learn.microsoft.com/en-us/rest/api/communication/rooms/participants/list

An example of a fully qualified HTTP GET request to retrieve room participants.

```HTTP
GET https://contoso.communication.azure.com//rooms/99199690362660524/participants?api-version=2025-03-13
```

--------------------------------

### Get Countries Sample Request

Source: https://learn.microsoft.com/en-us/rest/api/communication/phonenumbers/phone-numbers/list-available-countries

A concrete example of a GET request to the available countries endpoint.

```HTTP
GET https://resourcename.communication.azure.com//availablePhoneNumbers/countries?api-version=2025-06-01
```

--------------------------------

### Get Operation Status Example

Source: https://learn.microsoft.com/en-us/rest/api/communication/phonenumbers/phone-numbers/get-operation

Example request and response for checking the status of a long-running operation.

```HTTP
GET https://resourcename.communication.azure.com//phoneNumbers/operations/search-my-operation-id?api-version=2025-06-01
```

```HTTP
Location: /availablePhoneNumbers/searchResults/378ddf60-81be-452a-ba4f-613198ea6c28
```

```JSON
{
  "status": "succeeded",
  "resourceLocation": "/availablePhoneNumbers/searchResults/378ddf60-81be-452a-ba4f-613198ea6c28",
  "createdDateTime": "2020-11-19T16:31:49.048Z",
  "id": "search-my-operation-id",
  "operationType": "search",
  "lastActionDateTime": "2020-11-19T22:31:49.048Z"
}
```

--------------------------------

### CallMedia_StartContinuousDtmfRecognition Sample Request

Source: https://learn.microsoft.com/en-us/rest/api/communication/callautomation/call-media/start-continuous-dtmf-recognition

A concrete example of a POST request to start continuous DTMF recognition for a specific participant.

```HTTP
POST https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c:startContinuousDtmfRecognition?api-version=2026-03-12

{
  "targetParticipant": {
    "kind": "communicationUser",
    "communicationUser": {
      "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
    }
  }
}
```

--------------------------------

### Get Message Status FailedTerminalStatus Examples

Source: https://learn.microsoft.com/en-us/rest/api/communication/email/email/get-send-result

Request and response examples for a failed email operation.

```HTTP
GET https://contoso.westus.communications.azure.com/emails/operations/F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4?api-version=2025-09-01
```

```JSON
{
  "id": "F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4",
  "status": "Failed",
  "error": {
    "code": "EmailDropped",
    "message": "Email was dropped after several attempts to deliver."
  }
}
```

--------------------------------

### Get Identity Example

Source: https://learn.microsoft.com/en-us/rest/api/communication/identity/communication-identity/get

A sample request and the corresponding JSON response for retrieving a specific communication identity.

```HTTP
GET https://my-resource.communication.azure.com/identities/8:acs:2dee53b4-368b-45b4-ab52-8493fb117652_00000005-14a2-493b-8a72-5a3a0d000081?api-version=2025-03-02-preview
```

```JSON
{
  "id": "8:acs:2dee53b4-368b-45b4-ab52-8493fb117652_00000005-14a2-493b-8a72-5a3a0d000081",
  "customId": "sally@contoso.com",
  "lastTokenIssuedAt": "2025-02-10T21:39:39.3244584+00:00"
}
```

--------------------------------

### Get Communication Service Resource Request

Source: https://learn.microsoft.com/en-us/rest/api/communication/resourcemanager/communication-service/get

Examples of how to request resource details using various interfaces.

```HTTP
GET https://management.azure.com/subscriptions/12345/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/communicationServices/MyCommunicationResource?api-version=2020-08-20
```

```Java
import com.azure.core.util.Context;

/** Samples for CommunicationService GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/get.json
     */
    /**
     * Sample code: Get resource.
     *
     * @param manager Entry point to CommunicationManager.
     */
    public static void getResource(com.azure.resourcemanager.communication.CommunicationManager manager) {
        manager
            .communicationServices()
            .getByResourceGroupWithResponse("MyResourceGroup", "MyCommunicationResource", Context.NONE);
    }
}
```

```Go
package armcommunication_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/communication/armcommunication"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/get.json
func ExampleServiceClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armcommunication.NewServiceClient("12345", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"MyResourceGroup",
		"MyCommunicationResource",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
```

```JavaScript
const { CommunicationServiceManagementClient } = require("@azure/arm-communication");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get the CommunicationService and its properties.
 *
 * @summary Get the CommunicationService and its properties.
 * x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/get.json
 */
async function getResource() {
  const subscriptionId = "12345";
  const resourceGroupName = "MyResourceGroup";
  const communicationServiceName = "MyCommunicationResource";
  const credential = new DefaultAzureCredential();
  const client = new CommunicationServiceManagementClient(credential, subscriptionId);
  const result = await client.communicationService.get(resourceGroupName, communicationServiceName);
  console.log(result);
}

getResource().catch(console.error);
```

--------------------------------

### Get Participants Sample Request

Source: https://learn.microsoft.com/en-us/rest/api/communication/chat/chat-thread/list-chat-participants

Example of a paginated request to fetch participants for a specific thread.

```HTTP
GET https://contoso.westus.communications.azure.com/chat/threads/19:f2167429acf6482880c6b7790a9086c1@thread.v2/participants?maxPageSize=2&api-version=2025-03-15
```

--------------------------------

### Retrieve Existing Queues Example

Source: https://learn.microsoft.com/en-us/rest/api/communication/jobrouter/job-router-administration-operations/list-queues

A concrete example of a request to list queues and the corresponding JSON response.

```HTTP
GET https://contoso.westus.communications.azure.com/routing/queues?api-version=2023-11-01&maxpagesize=2
```

```JSON
{
  "value": [
    {
      "id": "MainQueue",
      "name": "Main",
      "distributionPolicyId": "MainDistributionPolicy",
      "labels": {},
      "exceptionPolicyId": "MainExceptionPolicy",
      "etag": "etag"
    },
    {
      "id": "SecondaryQueue",
      "name": "Secondary",
      "distributionPolicyId": "SecondaryDistributionPolicy",
      "labels": {},
      "exceptionPolicyId": "SecondaryExceptionPolicy",
      "etag": "etag"
    }
  ],
  "nextLink": null
}
```

--------------------------------

### Accept Job Offer Request Example

Source: https://learn.microsoft.com/en-us/rest/api/communication/jobrouter/job-router-operations/accept-job-offer

A concrete example of an HTTP POST request to accept a specific job offer.

```HTTP
POST https://contoso.westus.communications.azure.com/routing/workers/DefaultWorker/offers/1d5896f3-8b54-40be-82d3-910323f5e2af:accept?api-version=2023-11-01
```

--------------------------------

### SenderUsernames resource response examples

Source: https://learn.microsoft.com/en-us/rest/api/communication/resourcemanager/sender-usernames/create-or-update

Examples of JSON responses for successful creation, successful update, and error scenarios.

```JSON
{
  "name": "contoso.com",
  "type": "Microsoft.Communication/EmailServices/Domains",
  "id": "/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/contosoResourceGroup/providers/Microsoft.Communication/EmailServices/contosoEmailService/Domains/contoso.com/senderUsernames/contosoNewsAlerts",
  "properties": {
    "dataLocation": "United States",
    "displayName": "Contoso News Alerts",
    "username": "contosoNewsAlerts"
  }
}
```

```JSON
{
  "name": "contoso.com",
  "type": "Microsoft.Communication/EmailServices/Domains",
  "id": "/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/contosoResourceGroup/providers/Microsoft.Communication/EmailServices/contosoEmailService/Domains/contoso.com/senderUsernames/contosoNewsAlerts",
  "properties": {
    "dataLocation": "United States",
    "displayName": "Contoso News Alerts",
    "username": "contosoNewsAlerts"
  }
}
```

```JSON
{
  "error": {
    "code": "ResourceNotFound",
    "message": "The requested resource was not found"
  }
}
```

--------------------------------

### Get Meeting Room Request and Response

Source: https://learn.microsoft.com/en-us/rest/api/communication/rooms/rooms/get

Example request and successful response for retrieving a specific meeting room.

```HTTP
GET https://contoso.communication.azure.com//rooms/99117812428622880?api-version=2025-03-13
```

```JSON
{
  "id": "99117812428622880",
  "createdAt": "2025-06-26T05:46:17.8159131+00:00",
  "validFrom": "2025-06-30T00:00:00+00:00",
  "validUntil": "2025-07-30T00:00:00+00:00",
  "pstnDialOutEnabled": true
}
```

--------------------------------

### Cancel Job Request and Response Examples

Source: https://learn.microsoft.com/en-us/rest/api/communication/jobrouter/job-router-operations/cancel-job

Examples demonstrating the request and response format for cancelling a job.

```HTTP
POST https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958:cancel?api-version=2023-11-01

{}
```

```JSON
{}
```

```HTTP
POST https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958:cancel?api-version=2023-11-01
```

--------------------------------

### Delete Queue Example Request

Source: https://learn.microsoft.com/en-us/rest/api/communication/jobrouter/job-router-administration-operations/delete-queue

A concrete example of a DELETE request targeting a specific queue.

```HTTP
DELETE https://contoso.westus.communications.azure.com/routing/queues/MainQueue?api-version=2023-11-01
```

--------------------------------

### Retrieve Queue Statistics Example

Source: https://learn.microsoft.com/en-us/rest/api/communication/jobrouter/job-router-operations/get-queue-statistics

A concrete example of a request and its corresponding JSON response for retrieving statistics for a specific queue.

```HTTP
GET https://contoso.westus.communications.azure.com/routing/queues/MainQueue/statistics?api-version=2023-11-01
```

```JSON
{
  "queueId": "MainQueue",
  "length": 5
}
```

--------------------------------

### Initiate Verification Examples

Source: https://learn.microsoft.com/en-us/rest/api/communication/resourcemanager/domains/initiate-verification

Sample request and response for initiating domain verification.

```HTTP
POST https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/emailServices/MyEmailServiceResource/domains/mydomain.com/initiateVerification?api-version=2026-03-18

{
  "verificationType": "SPF"
}
```

```javascript
const { CommunicationServiceManagementClient } = require("@azure/arm-communication");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to initiate verification of DNS record.
 *
 * @summary initiate verification of DNS record.
 * x-ms-original-file: 2026-03-18/domains/initiateVerification.json
 */
async function initiateVerification() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "11112222-3333-4444-5555-666677778888";
  const client = new CommunicationServiceManagementClient(credential, subscriptionId);
  await client.domains.initiateVerification(
    "MyResourceGroup",
    "MyEmailServiceResource",
    "mydomain.com",
    { verificationType: "SPF" },
  );
}
```

```HTTP
Location: https://management.azure.com/providers/Microsoft.Communication/locations/westus/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d
Retry-After: 60
```

--------------------------------

### Delete Resource Example

Source: https://learn.microsoft.com/en-us/rest/api/communication/resourcemanager/communication-services/delete

Example request for deleting a specific Communication Service resource using HTTP and the JavaScript SDK.

```HTTP
DELETE https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/communicationServices/MyCommunicationResource?api-version=2026-03-18
```

```js
const { CommunicationServiceManagementClient } = require("@azure/arm-communication");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to operation to delete a CommunicationService.
 *
 * @summary operation to delete a CommunicationService.
 * x-ms-original-file: 2026-03-18/communicationServices/delete.json
 */
async function deleteResource() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "11112222-3333-4444-5555-666677778888";
  const client = new CommunicationServiceManagementClient(credential, subscriptionId);
  await client.communicationServices.delete("MyResourceGroup", "MyCommunicationResource");
}
```

--------------------------------

### Create a new job

Source: https://learn.microsoft.com/en-us/rest/api/communication/jobrouter/job-router-operations/upsert-job

Request and response examples for creating a new job with queueAndMatch mode.

```HTTP
PATCH https://contoso.westus.communications.azure.com/routing/jobs/JobId?api-version=2023-11-01

{
  "channelId": "CustomChatChannel",
  "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af",
  "queueId": "MainQueue",
  "priority": 5,
  "requestedWorkerSelectors": [
    {
      "key": "Sales",
      "labelOperator": "equal",
      "value": true
    }
  ],
  "labels": {},
  "matchingMode": {
    "kind": "queueAndMatch"
  }
}
```

```JSON
{
  "id": "JobId",
  "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af",
  "status": "queued",
  "enqueuedAt": "2021-09-30T23:59:04.5311999+00:00",
  "channelId": "CustomChatChannel",
  "classificationPolicyId": null,
  "queueId": "MainQueue",
  "priority": 5,
  "dispositionCode": null,
  "requestedWorkerSelectors": [
    {
      "key": "Sales",
      "labelOperator": "equal",
      "value": true,
      "expiresAfterSeconds": null
    }
  ],
  "attachedWorkerSelectors": [],
  "labels": {},
  "assignments": {},
  "notes": [],
  "matchingMode": {
    "kind": "queueAndMatch"
  },
  "etag": "etag"
}
```

--------------------------------

### Sample response for list domains

Source: https://learn.microsoft.com/en-us/rest/api/communication/resourcemanager/domains/list-by-email-service-resource

Example JSON response returned upon a successful 200 OK request.

```JSON
{
  "value": [
    {
      "name": "mydomain.com",
      "type": "Microsoft.Communication/EmailServices/Domains",
      "id": "/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/EmailServices/MyEmailServiceResource/Domains/mydomain.com",
      "location": "Global",
      "properties": {
        "dataLocation": "United States",
        "domainManagement": "CustomerManaged",
        "fromSenderDomain": "mydomain.com",
        "mailFromSenderDomain": "mydomain.com",
        "provisioningState": "Running",
        "verificationRecords": {
          "Domain": {
            "name": "recordName",
            "type": "TXT",
            "ttl": 3600,
            "value": "recordValue"
          },
          "SPF": {
            "name": "recordName",
            "type": "TXT",
            "ttl": 3600,
            "value": "recordValue"
          }
        },
        "verificationStates": {
          "Domain": {
            "errorCode": "",
            "status": "Verified"
          },
          "SPF": {
            "errorCode": "",
            "status": "NotStarted"
          }
        }
      }
    }
  ]
}
```

--------------------------------

### Get Message Status NonTerminalStatus Examples

Source: https://learn.microsoft.com/en-us/rest/api/communication/email/email/get-send-result

Request and response examples for an email operation that is still in progress.

```HTTP
GET https://contoso.westus.communications.azure.com/emails/operations/F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4?api-version=2025-09-01
```

```HTTP
retry-after: 100
```

```JSON
{
  "id": "F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4",
  "status": "Running"
}
```

--------------------------------

### List Keys Sample Request

Source: https://learn.microsoft.com/en-us/rest/api/communication/resourcemanager/communication-services/list-keys

Example HTTP and JavaScript requests for listing Communication Service keys.

```HTTP
POST https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/communicationServices/MyCommunicationResource/listKeys?api-version=2026-03-18
```

```javascript
const { CommunicationServiceManagementClient } = require("@azure/arm-communication");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to get the access keys of the CommunicationService resource.
 *
 * @summary get the access keys of the CommunicationService resource.
 * x-ms-original-file: 2026-03-18/communicationServices/listKeys.json
 */
async function listKeys() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "11112222-3333-4444-5555-666677778888";
  const client = new CommunicationServiceManagementClient(credential, subscriptionId);
  const result = await client.communicationServices.listKeys(
    "MyResourceGroup",
    "MyCommunicationResource",
  );
  console.log(result);
}
```

--------------------------------

### Get OperationStatus Sample Request

Source: https://learn.microsoft.com/en-us/rest/api/communication/resourcemanager/operation-statuses/get

A concrete example of a GET request for a specific operation ID in the westus2 region.

```HTTP
GET https://management.azure.com/providers/Microsoft.Communication/locations/westus2/operationStatuses/db5f291f-284d-46e9-9152-d5c83f7c14b8?api-version=2020-08-20-preview
```

--------------------------------

### Get Chat Image Sample Request

Source: https://learn.microsoft.com/en-us/rest/api/communication/chat/chat-thread/get-chat-image

A concrete example of a GET request to retrieve an image from a specific chat thread.

```HTTP
GET https://contoso.westus.communications.azure.com/chat/threads/19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2/images/0-eus-d2-fb42e272282ebb6ef76a3aedd1974433/view/original?api-version=2025-11-15-preview
```

--------------------------------

### List Communication Services by Subscription

Source: https://learn.microsoft.com/en-us/rest/api/communication/resourcemanager/communication-service/list-by-subscription

Examples for listing resources using various programming languages and the REST API.

```HTTP
GET https://management.azure.com/subscriptions/12345/providers/Microsoft.Communication/communicationServices?api-version=2020-08-20
```

```Java
import com.azure.core.util.Context;

/** Samples for CommunicationService List. */
public final class Main {
    /*
     * x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/listBySubscription.json
     */
    /**
     * Sample code: List by subscription.
     *
     * @param manager Entry point to CommunicationManager.
     */
    public static void listBySubscription(com.azure.resourcemanager.communication.CommunicationManager manager) {
        manager.communicationServices().list(Context.NONE);
    }
}
```

```Go
package armcommunication_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/communication/armcommunication"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/listBySubscription.json
func ExampleServiceClient_NewListBySubscriptionPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armcommunication.NewServiceClient("12345", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListBySubscriptionPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
```

```JavaScript
const { CommunicationServiceManagementClient } = require("@azure/arm-communication");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Handles requests to list all resources in a subscription.
 *
 * @summary Handles requests to list all resources in a subscription.
 * x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/listBySubscription.json
 */
async function listBySubscription() {
  const subscriptionId = "12345";
  const credential = new DefaultAzureCredential();
  const client = new CommunicationServiceManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.communicationService.listBySubscription()) {
    resArray.push(item);
  }
  console.log(resArray);
}

listBySubscription().catch(console.error);
```

--------------------------------

### Sample Get Chat Thread Request

Source: https://learn.microsoft.com/en-us/rest/api/communication/chat/chat/get-chat-thread

An example of a fully formed HTTP GET request to retrieve a chat thread.

```HTTP
GET https://contoso.westus.communications.azure.com/chat/threads/19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2?api-version=2021-01-27-preview4
```

--------------------------------

### Get Participants Request and Response

Source: https://learn.microsoft.com/en-us/rest/api/communication/callautomation/call-connection/get-participants

Example of a GET request to retrieve call participants and the corresponding JSON response structure.

```HTTP
GET https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c/participants?api-version=2026-03-12
```

```JSON
{
  "value": [
    {
      "identifier": {
        "kind": "communicationUser",
        "communicationUser": {
          "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
        }
      },
      "isMuted": true
    }
  ],
  "nextLink": "string"
}
```

--------------------------------

### Get PhoneNumber Search Result Request

Source: https://learn.microsoft.com/en-us/rest/api/communication/phonenumbers/phone-numbers/list-available-localities

Example HTTP GET request to retrieve available phone number localities for Canada.

```HTTP
GET https://resourcename.communication.azure.com//availablePhoneNumbers/countries/CA/localities?api-version=2025-06-01&phoneNumberType=mobile
```

--------------------------------

### Connect API Response Example

Source: https://learn.microsoft.com/en-us/rest/api/communication/callautomation/connect/connect

A successful 200 OK response containing the call connection properties and subscription details.

```JSON
{
  "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
  "serverCallId": "aHR0cHM6Ly9jb252ZXJzYXRpb251cmwvdGVzdA",
  "targets": [],
  "callConnectionState": "connecting",
  "callbackUri": "https://contoso.communications.azure.com/callback",
  "mediaStreamingSubscription": {
    "id": "23dea47f-b081-4107-9a5c-4300819d2caa",
    "state": "active",
    "subscribedContentTypes": [
      "audio"
    ]
  },
  "transcriptionSubscription": {
    "id": "45dea47f-b081-4107-9a5c-4300819d2caa",
    "state": "active",
    "subscribedResultTypes": [
      "final"
    ]
  },
  "answeredFor": {
    "value": "+11234567890"
  }
}
```

--------------------------------

### Get threads with pagination HTTP request

Source: https://learn.microsoft.com/en-us/rest/api/communication/chat/chat/list-chat-threads

Example of a GET request to retrieve chat threads with a specified maximum page size.

```HTTP
GET https://contoso.westus.communications.azure.com/chat/threads?maxPageSize=5&api-version=2025-03-15
```

--------------------------------

### GetDeliveryReport Sample Request

Source: https://learn.microsoft.com/en-us/rest/api/communication/sms/delivery-reports/get

An example of a concrete HTTP GET request for a specific message ID.

```HTTP
GET {endpoint}/deliveryReports/abc123-message-id?api-version=2026-01-23
```

--------------------------------

### Creating the String to Sign

Source: https://learn.microsoft.com/en-us/rest/api/communication/authentication

Concatenate the request components into the specific format required for signing.

```pseudocode
StringToSign=Verb + "\n"
URIPathAndQuery + "\n"
Timestamp + ";" + Host + ";" + ContentHash
```

--------------------------------

### Upload Image Response Examples

Source: https://learn.microsoft.com/en-us/rest/api/communication/chat/chat-thread/upload-chat-image

Sample response headers and JSON body returned after a successful image upload.

```HTTP
Location: /chat/threads/19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2/images/0-eus-d2-fb42e272282ebb6ef76a3aedd1974433
```

```JSON
{
  "id": "0-eus-d2-fb42e272282ebb6ef76a3aedd1974433",
  "attachmentType": "inlineImage",
  "name": "sample.png"
}
```

--------------------------------

### List Communication Service Keys

Source: https://learn.microsoft.com/en-us/rest/api/communication/resourcemanager/communication-service/list-keys

Examples for retrieving access keys for a specific Communication Service resource.

```HTTP
POST https://management.azure.com/subscriptions/12345/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/communicationServices/MyCommunicationResource/listKeys?api-version=2020-08-20
```

```Java
import com.azure.core.util.Context;

/** Samples for CommunicationService ListKeys. */
public final class Main {
    /*
     * x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/listKeys.json
     */
    /**
     * Sample code: List keys.
     *
     * @param manager Entry point to CommunicationManager.
     */
    public static void listKeys(com.azure.resourcemanager.communication.CommunicationManager manager) {
        manager
            .communicationServices()
            .listKeysWithResponse("MyResourceGroup", "MyCommunicationResource", Context.NONE);
    }
}
```

```Go
package armcommunication_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/communication/armcommunication"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/listKeys.json
func ExampleServiceClient_ListKeys() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armcommunication.NewServiceClient("12345", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListKeys(ctx,
		"MyResourceGroup",
		"MyCommunicationResource",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
```

```JavaScript
const { CommunicationServiceManagementClient } = require("@azure/arm-communication");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get the access keys of the CommunicationService resource.
 *
 * @summary Get the access keys of the CommunicationService resource.
 * x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/listKeys.json
 */
async function listKeys() {
  const subscriptionId = "12345";
  const resourceGroupName = "MyResourceGroup";
  const communicationServiceName = "MyCommunicationResource";
  const credential = new DefaultAzureCredential();
  const client = new CommunicationServiceManagementClient(credential, subscriptionId);
  const result = await client.communicationService.listKeys(
    resourceGroupName,
    communicationServiceName
  );
  console.log(result);
}

listKeys().catch(console.error);
```

--------------------------------

### Get Chat Message Responses

Source: https://learn.microsoft.com/en-us/rest/api/communication/chat/chat-thread/get-chat-message

JSON response examples for successful retrieval and various error conditions.

```JSON
{
  "id": "1591768249318",
  "sequenceId": "1",
  "type": "text",
  "version": "1599016601134",
  "content": {
    "message": "Let's head out for lunch in 15 minutes."
  },
  "senderDisplayName": "Jane",
  "createdOn": "2020-06-10T05:50:49.3180000Z",
  "senderCommunicationIdentifier": {
    "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b",
    "communicationUser": {
      "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
    }
  },
  "metadata": {
    "someKey1": "someValue1",
    "someKey2": "someValue2"
  }
}
```

```JSON
{
  "error": {
    "code": "Unauthorized",
    "message": "Request is not authorized."
  }
}
```

```JSON
{
  "error": {
    "code": "Forbidden",
    "message": "User is not allowed to perform specified action."
  }
}
```

```JSON
{
  "error": {
    "code": "TooManyRequests",
    "message": "Rate limit exceeded."
  }
}
```

```JSON
{
  "error": {
    "code": "ServiceUnavailable",
    "message": "The server is currently unable to handle the request."
  }
}
```

--------------------------------

### Get a SuppressionList resource request

Source: https://learn.microsoft.com/en-us/rest/api/communication/resourcemanager/suppression-lists/get

Examples of how to request a SuppressionList resource using HTTP and the Azure SDK for JavaScript.

```HTTP
GET https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/contosoResourceGroup/providers/Microsoft.Communication/emailServices/contosoEmailService/domains/contoso.com/suppressionLists/aaaa1111-bbbb-2222-3333-aaaa11112222?api-version=2026-03-18
```

```JavaScript
const { CommunicationServiceManagementClient } = require("@azure/arm-communication");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to get a SuppressionList resource.
 *
 * @summary get a SuppressionList resource.
 * x-ms-original-file: 2026-03-18/suppressionLists/getSuppressionList.json
 */
async function getASuppressionListResource() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "11112222-3333-4444-5555-666677778888";
  const client = new CommunicationServiceManagementClient(credential, subscriptionId);
  const result = await client.suppressionLists.get(
    "contosoResourceGroup",
    "contosoEmailService",
    "contoso.com",
    "aaaa1111-bbbb-2222-3333-aaaa11112222",
  );
  console.log(result);
}
```
Tokens:
Raw