Azure Communication Services: Communicationservicejobrouter
Azure Communication Routing Service
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Azure Communication Routing Service
Endpoints 33
- GETRetrieves existing classification policies.
/routing/classificationPolicies?api-version=string&maxpagesize=0Retrieves existing classification policies. - GETRetrieves an existing classification policy by Id.
/routing/classificationPolicies/:classificationPolicyId?api-version=stringRetrieves an existing classification policy by Id. - DELETEDelete a classification policy by Id.
/routing/classificationPolicies/:classificationPolicyId?api-version=stringDelete a classification policy by Id. - PATCHCreates or updates a classification policy.
/routing/classificationPolicies/:classificationPolicyId?api-version=stringCreates or updates a classification policy. - GETRetrieves existing distribution policies.
/routing/distributionPolicies?api-version=string&maxpagesize=0Retrieves existing distribution policies. - GETRetrieves an existing distribution policy by Id.
/routing/distributionPolicies/:distributionPolicyId?api-version=stringRetrieves an existing distribution policy by Id. - DELETEDelete a distribution policy by Id.
/routing/distributionPolicies/:distributionPolicyId?api-version=stringDelete a distribution policy by Id. - PATCHCreates or updates a distribution policy.
/routing/distributionPolicies/:distributionPolicyId?api-version=stringCreates or updates a distribution policy. - GETRetrieves existing exception policies.
/routing/exceptionPolicies?api-version=string&maxpagesize=0Retrieves existing exception policies. - GETRetrieves an existing exception policy by Id.
/routing/exceptionPolicies/:exceptionPolicyId?api-version=stringRetrieves an existing exception policy by Id. - DELETEDeletes a exception policy by Id.
/routing/exceptionPolicies/:exceptionPolicyId?api-version=stringDeletes a exception policy by Id. - PATCHCreates or updates a exception policy.
/routing/exceptionPolicies/:exceptionPolicyId?api-version=stringCreates or updates a exception policy. - GETRetrieves list of jobs based on filter parameters.
/routing/jobs?api-version=string&maxpagesize=0&status=all&queueId=string&channelId=string&classificationPolicyId=string&scheduledBefore=2024-01-01T00:00:00Z&scheduledAfter=2024-01-01T00:00:00ZRetrieves list of jobs based on filter parameters. - GETRetrieves an existing job by Id.
/routing/jobs/:jobId?api-version=stringRetrieves an existing job by Id. - DELETEDeletes a job and all of its traces.
/routing/jobs/:jobId?api-version=stringDeletes a job and all of its traces. - PATCHCreates or updates a router job.
/routing/jobs/:jobId?api-version=stringCreates or updates a router job. - POSTReclassify a job.
/routing/jobs/:jobId:reclassify?api-version=stringReclassify a job. - POSTSubmits request to cancel an existing job by Id while supplying free-form cancellation reason.
/routing/jobs/:jobId:cancel?api-version=stringSubmits request to cancel an existing job by Id while supplying free-form cancellation reason. - POSTCompletes an assigned job.
/routing/jobs/:jobId/assignments/:assignmentId:complete?api-version=stringCompletes an assigned job. - POSTCloses a completed job.
/routing/jobs/:jobId/assignments/:assignmentId:close?api-version=stringCloses a completed job. - POSTUnassign a job.
/routing/jobs/:jobId/assignments/:assignmentId:unassign?api-version=stringUnassign a job. - GETGets a job's position details.
/routing/jobs/:jobId/position?api-version=stringGets a job's position details. - GETRetrieves existing queues.
/routing/queues?api-version=string&maxpagesize=0Retrieves existing queues. - GETRetrieves an existing queue by Id.
/routing/queues/:queueId?api-version=stringRetrieves an existing queue by Id. - DELETEDeletes a queue by Id.
/routing/queues/:queueId?api-version=stringDeletes a queue by Id. - PATCHCreates or updates a queue.
/routing/queues/:queueId?api-version=stringCreates or updates a queue. - GETRetrieves a queue's statistics.
/routing/queues/:queueId/statistics?api-version=stringRetrieves a queue's statistics. - GETRetrieves existing workers.
/routing/workers?api-version=string&maxpagesize=0&state=all&channelId=string&queueId=string&hasCapacity=trueRetrieves existing workers. - GETRetrieves an existing worker by Id.
/routing/workers/:workerId?api-version=stringRetrieves an existing worker by Id. - DELETEDeletes a worker and all of its traces.
/routing/workers/:workerId?api-version=stringDeletes a worker and all of its traces. - PATCHCreates or updates a worker.
/routing/workers/:workerId?api-version=stringCreates or updates a worker. - POSTAccepts an offer to work on a job and returns a 409/Conflict if another agent accepted the job already.
/routing/workers/:workerId/offers/:offerId:accept?api-version=stringAccepts an offer to work on a job and returns a 409/Conflict if another agent accepted the job already. - POSTDeclines an offer to work on a job.
/routing/workers/:workerId/offers/:offerId:decline?api-version=stringDeclines an offer to work on a job.
API details
- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
- Operations
- 33 operations on 21 pathsGET 14POST 7PATCH 6DELETE 6
- Response formats
application/json- Description format
- Swagger 2.0, API version
2023-11-01 - Links
- OpenAPI document
How to test the Azure Communication Services: Communicationservicejobrouter in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Communication Services: Communicationservicejobrouter collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Retrieves existing classification policies.” (GET /routing/classificationPolicies?api-version=string&maxpagesize=0), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Azure Communication Services: Communicationservicejobrouter?
Azure Communication Routing Service It is listed under Communication and has 33 endpoints.
Who publishes the Azure Communication Services: Communicationservicejobrouter?
It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.
How do I authenticate with the Azure Communication Services: Communicationservicejobrouter?
With OAuth 2.0 (authorization code flow) with 1 scope.
How many endpoints does the Azure Communication Services: Communicationservicejobrouter have?
33 operations on 21 paths (14 GET, 7 POST, 6 PATCH, 6 DELETE).
Is forking the Azure Communication Services: Communicationservicejobrouter free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.