{ "opencollection": "1.0.0", "info": { "name": "PureCloud Platform Agent Assistants Routing API", "version": "v2" }, "items": [ { "info": { "name": "Routing", "type": "folder" }, "items": [ { "info": { "name": "Query for queue observations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/queues/observations/query" }, "docs": "Query for queue observations" }, { "info": { "name": "Query for user activity observations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/routing/activity/query", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The desired page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The desired page number" } ] }, "docs": "Query for user activity observations" }, { "info": { "name": "Get Estimated Wait Time", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/queues/:queueId/estimatedwaittime", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "queueId" }, { "name": "conversationId", "value": "", "type": "query", "description": "conversationId" } ] }, "docs": "Get Estimated Wait Time" }, { "info": { "name": "Get Estimated Wait Time", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/queues/:queueId/mediatypes/:mediaType/estimatedwaittime", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "queueId" }, { "name": "mediaType", "value": "", "type": "path", "description": "mediaType" }, { "name": "labelId", "value": "", "type": "query", "description": "Unique id that represents the interaction label used with media type for EWT calculation" } ] }, "docs": "Get Estimated Wait Time" }, { "info": { "name": "Get available media types", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/availablemediatypes" }, "docs": "Get available media types" }, { "info": { "name": "Get a routing language", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/languages/:languageId", "params": [ { "name": "languageId", "value": "", "type": "path", "description": "Language ID" } ] }, "docs": "Get a routing language" }, { "info": { "name": "Delete a routing language", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/routing/languages/:languageId", "params": [ { "name": "languageId", "value": "", "type": "path", "description": "Language ID" } ] }, "docs": "Delete a routing language" }, { "info": { "name": "Get the list of supported languages.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/languages", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Ascending or descending sort order" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "id", "value": "", "type": "query", "description": "id" } ] }, "docs": "Get the list of supported languages." }, { "info": { "name": "Create Language", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/languages" }, "docs": "Create Language" }, { "info": { "name": "Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/queues/divisionviews", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size [max value is 100]" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number [max value is 5]" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "id", "value": "", "type": "query", "description": "Queue ID(s)" }, { "name": "divisionId", "value": "", "type": "query", "description": "Division ID(s). Including '*' will query for all divisions" } ] }, "docs": "Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s)." }, { "info": { "name": "Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/queues/divisionviews/all", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size [max value is 500]" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization." }, { "info": { "name": "Get Queue IdentityResolution Settings.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/queues/:queueId/identityresolution", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "Queue ID" } ] }, "docs": "Get Queue IdentityResolution Settings." }, { "info": { "name": "Update Queue IdentityResolution Settings.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/routing/queues/:queueId/identityresolution", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "Queue ID" } ] }, "docs": "Update Queue IdentityResolution Settings." }, { "info": { "name": "Get details about this queue.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/queues/:queueId", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "Queue ID" }, { "name": "expand", "value": "", "type": "query", "description": "Which fields, if any, to expand" } ] }, "docs": "Get details about this queue." }, { "info": { "name": "Update a queue", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/routing/queues/:queueId", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "Queue ID" } ] }, "docs": "Update a queue" }, { "info": { "name": "Delete a queue", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/routing/queues/:queueId", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "Queue ID" }, { "name": "forceDelete", "value": "", "type": "query", "description": "forceDelete" } ] }, "docs": "Delete a queue" }, { "info": { "name": "Get the wrap-up codes for a queue", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/queues/:queueId/wrapupcodes", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "Queue ID" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "name", "value": "", "type": "query", "description": "Wrapup code's name (trailing asterisks allowed)" } ] }, "docs": "Get the wrap-up codes for a queue" }, { "info": { "name": "Add up to 100 wrap-up codes to a queue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/queues/:queueId/wrapupcodes", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "Queue ID" } ] }, "docs": "Add up to 100 wrap-up codes to a queue" }, { "info": { "name": "Delete a wrap-up code from a queue", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/routing/queues/:queueId/wrapupcodes/:codeId", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "Queue ID" }, { "name": "codeId", "value": "", "type": "path", "description": "Code ID" } ] }, "docs": "Delete a wrap-up code from a queue" }, { "info": { "name": "Get a paged listing of queues the user is a member of.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/queues/me", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "joined", "value": "", "type": "query", "description": "Filter by joined status." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Note: results are sorted by name." } ] }, "docs": "Get a paged listing of queues the user is a member of." }, { "info": { "name": "Get list of queues.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/queues", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Note: results are sorted by name." }, { "name": "name", "value": "", "type": "query", "description": "Include only queues with the given name (leading and trailing asterisks allowed)" }, { "name": "id", "value": "", "type": "query", "description": "Include only queues with the specified ID(s)" }, { "name": "divisionId", "value": "", "type": "query", "description": "Include only queues in the specified division ID(s)" }, { "name": "peerId", "value": "", "type": "query", "description": "Include only queues with the specified peer ID(s)" }, { "name": "cannedResponseLibraryId", "value": "", "type": "query", "description": "Include only queues explicitly associated with the specified canned response library ID" }, { "name": "hasPeer", "value": "", "type": "query", "description": "Include only queues with a peer ID" }, { "name": "expand", "value": "", "type": "query", "description": "Which fields, if any, to expand" } ] }, "docs": "Get list of queues." }, { "info": { "name": "Create a queue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/queues" }, "docs": "Create a queue" }, { "info": { "name": "Get Transcription Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/settings/transcription" }, "docs": "Get Transcription Settings" }, { "info": { "name": "Update Transcription Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/routing/settings/transcription" }, "docs": "Update Transcription Settings" }, { "info": { "name": "Patch Transcription Settings", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/routing/settings/transcription" }, "docs": "Patch Transcription Settings" }, { "info": { "name": "Get Contact Center Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/settings/contactcenter" }, "docs": "Get Contact Center Settings" }, { "info": { "name": "Update Contact Center Settings", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/routing/settings/contactcenter" }, "docs": "Update Contact Center Settings" }, { "info": { "name": "Get an organization's routing settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/settings" }, "docs": "Get an organization's routing settings" }, { "info": { "name": "Update an organization's routing settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/routing/settings" }, "docs": "Update an organization's routing settings" }, { "info": { "name": "Delete an organization's routing settings", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/routing/settings" }, "docs": "Delete an organization's routing settings" }, { "info": { "name": "Get Routing Skill", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/skills/:skillId", "params": [ { "name": "skillId", "value": "", "type": "path", "description": "Skill ID" } ] }, "docs": "Get Routing Skill" }, { "info": { "name": "Update Routing Skill Division", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/routing/skills/:skillId", "params": [ { "name": "skillId", "value": "", "type": "path", "description": "Skill ID" } ] }, "docs": "Update Routing Skill Division" }, { "info": { "name": "Delete Routing Skill", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/routing/skills/:skillId", "params": [ { "name": "skillId", "value": "", "type": "path", "description": "Skill ID" } ] }, "docs": "Delete Routing Skill" }, { "info": { "name": "Get the list of routing skills. View permission enforcement only applies to skills assigned to a division.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/skills", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "name", "value": "", "type": "query", "description": "Filter for results that start with this value" }, { "name": "id", "value": "", "type": "query", "description": "id" } ] }, "docs": "Get the list of routing skills. View permission enforcement only applies to skills assigned to a division." }, { "info": { "name": "Create Skill", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/skills" }, "docs": "Create Skill" }, { "info": { "name": "Get details about this utilization label", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/utilization/labels/:labelId", "params": [ { "name": "labelId", "value": "", "type": "path", "description": "Utilization Label ID" } ] }, "docs": "Get details about this utilization label" }, { "info": { "name": "Update a utilization label", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/routing/utilization/labels/:labelId", "params": [ { "name": "labelId", "value": "", "type": "path", "description": "Utilization Label ID" } ] }, "docs": "Update a utilization label" }, { "info": { "name": "Delete a utilization label", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/routing/utilization/labels/:labelId", "params": [ { "name": "labelId", "value": "", "type": "path", "description": "Utilization Label ID" }, { "name": "forceDelete", "value": "", "type": "query", "description": "Remove all label usages (if found) without warning" } ] }, "docs": "Delete a utilization label" }, { "info": { "name": "Get list of agent ids associated with a utilization label", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/utilization/labels/:labelId/agents", "params": [ { "name": "labelId", "value": "", "type": "path", "description": "Utilization Label ID" } ] }, "docs": "Get list of agent ids associated with a utilization label" }, { "info": { "name": "Get list of utilization labels", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/utilization/labels", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order by name" }, { "name": "name", "value": "", "type": "query", "description": "Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*'" } ] }, "docs": "Get list of utilization labels" }, { "info": { "name": "Create a utilization label", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/utilization/labels" }, "docs": "Create a utilization label" }, { "info": { "name": "Get the organization-wide max utilization settings.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/utilization" }, "docs": "Get the organization-wide max utilization settings." }, { "info": { "name": "Update the organization-wide max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the system default values.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/routing/utilization" }, "docs": "Update the organization-wide max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the system default values." }, { "info": { "name": "Delete the organization-wide max utilization settings and revert to the system default.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/routing/utilization" }, "docs": "Delete the organization-wide max utilization settings and revert to the system default." }, { "info": { "name": "Retrieve a single benefit assessment.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/assessments/:assessmentId", "params": [ { "name": "assessmentId", "value": "", "type": "path", "description": "Benefit Assessment ID" } ] }, "docs": "Retrieve a single benefit assessment." }, { "info": { "name": "Delete single benefit assessment.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/routing/assessments/:assessmentId", "params": [ { "name": "assessmentId", "value": "", "type": "path", "description": "Benefit Assessment ID" } ] }, "docs": "Delete single benefit assessment." }, { "info": { "name": "Retrieve all benefit assessments.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/assessments", "params": [ { "name": "before", "value": "", "type": "query", "description": "The cursor that points to the start of the set of entities that has been returned." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "limit", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 200. Deprecated in favour of pageSize" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 200." }, { "name": "queueId", "value": "", "type": "query", "description": "Queue ID(s) to filter assessments by." } ] }, "docs": "Retrieve all benefit assessments." }, { "info": { "name": "Create a benefit assessment.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/assessments" }, "docs": "Create a benefit assessment." }, { "info": { "name": "Retrieve a single benefit assessments job.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/assessments/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "Benefit Assessment Job ID" } ] }, "docs": "Retrieve a single benefit assessments job." }, { "info": { "name": "Retrieve all benefit assessment jobs.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/assessments/jobs", "params": [ { "name": "divisionId", "value": "", "type": "query", "description": "Division ID(s) to filter assessment jobs by." } ] }, "docs": "Retrieve all benefit assessment jobs." }, { "info": { "name": "Create a benefit assessment job.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/assessments/jobs" }, "docs": "Create a benefit assessment job." }, { "info": { "name": "Update attributes of an in-queue conversation", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/routing/conversations/:conversationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" } ] }, "docs": "Returns an object indicating the updated values of all settable attributes. Supported attributes: skillIds, skillExpression, languageId, and priority." }, { "info": { "name": "Get domain", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/email/domains/:domainId", "params": [ { "name": "domainId", "value": "", "type": "path", "description": "domain ID" }, { "name": "expand", "value": "", "type": "query", "description": "Expand options. Valid values: settings" } ] }, "docs": "Get domain" }, { "info": { "name": "Update domain settings", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/routing/email/domains/:domainId", "params": [ { "name": "domainId", "value": "", "type": "path", "description": "domain ID" } ] }, "docs": "Update domain settings" }, { "info": { "name": "Delete a domain", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/routing/email/domains/:domainId", "params": [ { "name": "domainId", "value": "", "type": "path", "description": "domain ID" } ] }, "docs": "Delete a domain" }, { "info": { "name": "Validate domain settings", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/routing/email/domains/:domainId/validate", "params": [ { "name": "domainId", "value": "", "type": "path", "description": "domain ID" } ] }, "docs": "Validate domain settings" }, { "info": { "name": "Get domain dkim settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/email/domains/:domainId/dkim", "params": [ { "name": "domainId", "value": "", "type": "path", "description": "domain ID" } ] }, "docs": "Get domain dkim settings" }, { "info": { "name": "Restart domain dkim", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/email/domains/:domainId/dkim", "params": [ { "name": "domainId", "value": "", "type": "path", "description": "domain ID" } ] }, "docs": "Restart domain dkim" }, { "info": { "name": "Get domain verification settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/email/domains/:domainId/verification", "params": [ { "name": "domainId", "value": "", "type": "path", "description": "domain ID" } ] }, "docs": "Get domain verification settings" }, { "info": { "name": "Restart domain verification", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/email/domains/:domainId/verification", "params": [ { "name": "domainId", "value": "", "type": "path", "description": "domain ID" } ] }, "docs": "Restart domain verification" }, { "info": { "name": "Get domain mail from settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/email/domains/:domainId/mailfrom", "params": [ { "name": "domainId", "value": "", "type": "path", "description": "domain ID" } ] }, "docs": "Get domain mail from settings" }, { "info": { "name": "Set domain mail from settings", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/email/domains/:domainId/mailfrom", "params": [ { "name": "domainId", "value": "", "type": "path", "description": "domain ID" } ] }, "docs": "Set domain mail from settings" }, { "info": { "name": "Tests the custom SMTP server integration connection set on this ACD domain", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/email/domains/:domainId/testconnection", "params": [ { "name": "domainId", "value": "", "type": "path", "description": "domain ID" } ] }, "docs": "The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server used by the ACD domain. If the body is specified, there will be an attempt to send an email message to the server." }, { "info": { "name": "Get domains", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/email/domains", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "excludeStatus", "value": "", "type": "query", "description": "Exclude MX record data" }, { "name": "filter", "value": "", "type": "query", "description": "Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter." }, { "name": "expand", "value": "", "type": "query", "description": "Expand options. Valid values: settings" } ] }, "docs": "Get domains" }, { "info": { "name": "Create a domain", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/email/domains" }, "docs": "Create a domain" }, { "info": { "name": "Get email setting. Returns the specified email setting that defines settings for email", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/email/setting/:emailSettingId", "params": [ { "name": "emailSettingId", "value": "", "type": "path", "description": "Email Setting ID" } ] }, "docs": "Get email setting. Returns the specified email setting that defines settings for email" }, { "info": { "name": "Update an email setting. Modifies the settings for email setting", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/routing/email/setting/:emailSettingId", "params": [ { "name": "emailSettingId", "value": "", "type": "path", "description": "Email Setting ID" } ] }, "docs": "Update an email setting. Modifies the settings for email setting" }, { "info": { "name": "Delete an email setting. Removes the email setting and its associated settings", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/routing/email/setting/:emailSettingId", "params": [ { "name": "emailSettingId", "value": "", "type": "path", "description": "Email Setting ID" } ] }, "docs": "Delete an email setting. Removes the email setting and its associated settings" }, { "info": { "name": "Get a paged list of email routing settings.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/email/setting", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "Get a paged list of email routing settings." }, { "info": { "name": "Create a new email setting. Used to define various settings, that can then be associated with email domains", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/email/setting" }, "docs": "Create a new email setting. Used to define various settings, that can then be associated with email domains" }, { "info": { "name": "Get email setup", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/email/setup" }, "docs": "Get email setup" }, { "info": { "name": "Get domain", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/email/outbound/domains/:domainId", "params": [ { "name": "domainId", "value": "", "type": "path", "description": "domain ID" }, { "name": "expand", "value": "", "type": "query", "description": "Expand options. Valid values: settings" } ] }, "docs": "Get domain" }, { "info": { "name": "Update configurable settings for an email domain, such as changing the sending method (e.g., to or from SMTP).", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/routing/email/outbound/domains/:domainId", "params": [ { "name": "domainId", "value": "", "type": "path", "description": "domain ID" } ] }, "docs": "Update configurable settings for an email domain, such as changing the sending method (e.g., to or from SMTP)." }, { "info": { "name": "Delete an outbound domain", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/routing/email/outbound/domains/:domainId", "params": [ { "name": "domainId", "value": "", "type": "path", "description": "domain ID" } ] }, "docs": "Delete an outbound domain" }, { "info": { "name": "Get activation status (cname + dkim) of an outbound domain", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/email/outbound/domains/:domainId/activation", "params": [ { "name": "domainId", "value": "", "type": "path", "description": "domain ID" } ] }, "docs": "Get activation status (cname + dkim) of an outbound domain" }, { "info": { "name": "Request an activation status (cname + dkim) update of an outbound domain", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/routing/email/outbound/domains/:domainId/activation", "params": [ { "name": "domainId", "value": "", "type": "path", "description": "domain ID" } ] }, "docs": "Request an activation status (cname + dkim) update of an outbound domain" }, { "info": { "name": "Tests the custom SMTP server integration connection set on this outbound domain", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/email/outbound/domains/:domainId/testconnection", "params": [ { "name": "domainId", "value": "", "type": "path", "description": "domain ID" } ] }, "docs": "The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server for the outbound domain. If the body is specified, there will be an attempt to send an email message to the server." }, { "info": { "name": "Get outbound domains", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/email/outbound/domains", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "filter", "value": "", "type": "query", "description": "Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter." }, { "name": "expand", "value": "", "type": "query", "description": "Expand options. Valid values: settings" } ] }, "docs": "Get outbound domains" }, { "info": { "name": "Create a domain", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/email/outbound/domains" }, "docs": "Create a domain" }, { "info": { "name": "Get a route identity resolution setting.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/email/domains/:domainName/routes/:routeId/identityresolution", "params": [ { "name": "domainName", "value": "", "type": "path", "description": "email domain" }, { "name": "routeId", "value": "", "type": "path", "description": "route ID" } ] }, "docs": "Get a route identity resolution setting." }, { "info": { "name": "Update identity resolution settings for a route.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/routing/email/domains/:domainName/routes/:routeId/identityresolution", "params": [ { "name": "domainName", "value": "", "type": "path", "description": "email domain" }, { "name": "routeId", "value": "", "type": "path", "description": "route ID" } ] }, "docs": "Update identity resolution settings for a route." }, { "info": { "name": "Get a route", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/email/domains/:domainName/routes/:routeId", "params": [ { "name": "domainName", "value": "", "type": "path", "description": "email domain" }, { "name": "routeId", "value": "", "type": "path", "description": "route ID" }, { "name": "expand", "value": "", "type": "query", "description": "Which fields, if any, to expand" } ] }, "docs": "Get a route" }, { "info": { "name": "Update a route", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/routing/email/domains/:domainName/routes/:routeId", "params": [ { "name": "domainName", "value": "", "type": "path", "description": "email domain" }, { "name": "routeId", "value": "", "type": "path", "description": "route ID" } ] }, "docs": "Update a route" }, { "info": { "name": "Delete a route", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/routing/email/domains/:domainName/routes/:routeId", "params": [ { "name": "domainName", "value": "", "type": "path", "description": "email domain" }, { "name": "routeId", "value": "", "type": "path", "description": "route ID" } ] }, "docs": "Delete a route" }, { "info": { "name": "Get routes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/email/domains/:domainName/routes", "params": [ { "name": "domainName", "value": "", "type": "path", "description": "email domain" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pattern", "value": "", "type": "query", "description": "Filter routes by the route's pattern property" }, { "name": "expand", "value": "", "type": "query", "description": "Which fields, if any, to expand" } ] }, "docs": "Get routes" }, { "info": { "name": "Create a route", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/email/domains/:domainName/routes", "params": [ { "name": "domainName", "value": "", "type": "path", "description": "email domain" } ] }, "docs": "Create a route" }, { "info": { "name": "Create a simulated domain", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/email/outbound/domains/simulated" }, "docs": "Create a simulated domain" }, { "info": { "name": "Get a recipient", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/message/recipients/:recipientId", "params": [ { "name": "recipientId", "value": "", "type": "path", "description": "Recipient ID" } ] }, "docs": "Get a recipient" }, { "info": { "name": "Update a recipient", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/routing/message/recipients/:recipientId", "params": [ { "name": "recipientId", "value": "", "type": "path", "description": "Recipient ID" } ] }, "docs": "Update a recipient" }, { "info": { "name": "Get recipients", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/message/recipients", "params": [ { "name": "messengerType", "value": "", "type": "query", "description": "Messenger Type" }, { "name": "name", "value": "", "type": "query", "description": "Recipient Name" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "Get recipients" }, { "info": { "name": "Get an Address by Id for SMS", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/sms/addresses/:addressId", "params": [ { "name": "addressId", "value": "", "type": "path", "description": "Address ID" } ] }, "docs": "Get an Address by Id for SMS" }, { "info": { "name": "Delete an Address by Id for SMS", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/routing/sms/addresses/:addressId", "params": [ { "name": "addressId", "value": "", "type": "path", "description": "Address ID" } ] }, "docs": "Delete an Address by Id for SMS" }, { "info": { "name": "Get a list of Addresses for SMS", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/sms/addresses", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "Get a list of Addresses for SMS" }, { "info": { "name": "Provision an Address for SMS", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/sms/addresses" }, "docs": "Provision an Address for SMS" }, { "info": { "name": "Get a list of available phone numbers for SMS provisioning.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/sms/availablephonenumbers", "params": [ { "name": "countryCode", "value": "", "type": "query", "description": "The ISO 3166-1 alpha-2 country code of the county for which available phone numbers should be returned" }, { "name": "region", "value": "", "type": "query", "description": "Region/province/state that can be used to restrict the numbers returned" }, { "name": "city", "value": "", "type": "query", "description": "City that can be used to restrict the numbers returned" }, { "name": "areaCode", "value": "", "type": "query", "description": "Area code that can be used to restrict the numbers returned" }, { "name": "phoneNumberType", "value": "", "type": "query", "description": "Type of available phone numbers searched" }, { "name": "pattern", "value": "", "type": "query", "description": "A pattern to match phone numbers. Valid characters are '*' and [0-9a-zA-Z]. The '*' character will match any single digit." }, { "name": "addressRequirement", "value": "", "type": "query", "description": "This indicates whether the phone number requires to have an Address registered." } ] }, "docs": "This request will return up to 30 random phone numbers matching the criteria specified. To get additional phone numbers repeat the request." }, { "info": { "name": "Get a SMS identity resolution settings.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/sms/identityresolution/phonenumbers/:addressId", "params": [ { "name": "addressId", "value": "", "type": "path", "description": "Address ID" } ] }, "docs": "Get a SMS identity resolution settings." }, { "info": { "name": "Update an SMS identity resolution settings.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/routing/sms/identityresolution/phonenumbers/:addressId", "params": [ { "name": "addressId", "value": "", "type": "path", "description": "Address ID" } ] }, "docs": "Update an SMS identity resolution settings." }, { "info": { "name": "Imports a phone number for SMS", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/sms/phonenumbers/import" }, "docs": "Imports a phone number for SMS" }, { "info": { "name": "Get a phone number provisioned for SMS.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/sms/phonenumbers/:phoneNumberId", "params": [ { "name": "phoneNumberId", "value": "", "type": "path", "description": "phone number" }, { "name": "expand", "value": "", "type": "query", "description": "Expand response with additional information" } ] }, "docs": "When no supported content profile is explicitly set on an MMS-capable phone number, the system uses the \"SMS Default\" profile. This default profile allows all media types (*/*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. The \"SMS Default\" profile does not have an ID and cannot be modified. To customize media filtering, create and assign a custom supported content profile using the PATCH endpoint." }, { "info": { "name": "Update a phone number provisioned for SMS.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/routing/sms/phonenumbers/:phoneNumberId", "params": [ { "name": "phoneNumberId", "value": "", "type": "path", "description": "phone number" } ] }, "docs": "Use this endpoint to assign a custom supported content profile to an MMS-capable phone number. If no supported content profile is set, the phone number uses the \"SMS Default\" profile, which allows all media types (*/*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. To customize media filtering, provide a supported content profile ID in the request body." }, { "info": { "name": "Delete a phone number provisioned for SMS.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/routing/sms/phonenumbers/:phoneNumberId", "params": [ { "name": "phoneNumberId", "value": "", "type": "path", "description": "phone number" } ] }, "docs": "Delete a phone number provisioned for SMS." }, { "info": { "name": "Get a list of provisioned phone numbers.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/sms/phonenumbers", "params": [ { "name": "phoneNumber", "value": "", "type": "query", "description": "Filter on phone number address. Allowable characters are the digits '0-9' and the wild card character '\\*'. If just digits are present, a contains search is done on the address pattern. For example, '317' could be matched anywhere in the address. An '\\*' will match multiple digits. For example, to match a specific area code within the US a pattern like '1317*' could be used." }, { "name": "phoneNumberType", "value": "", "type": "query", "description": "Filter on phone number type" }, { "name": "phoneNumberStatus", "value": "", "type": "query", "description": "Filter on phone number status" }, { "name": "countryCode", "value": "", "type": "query", "description": "Filter on country code" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "sortBy", "value": "", "type": "query", "description": "Optional field to sort results" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "language", "value": "", "type": "query", "description": "A language tag (which is sometimes referred to as a \"locale identifier\") to use to localize country field and sort operations" }, { "name": "integration.id", "value": "", "type": "query", "description": "Filter on the Genesys Cloud integration id to which the phone number belongs to" }, { "name": "supportedContent.id", "value": "", "type": "query", "description": "Filter based on the supported content ID" }, { "name": "expand", "value": "", "type": "query", "description": "Which fields, if any, to expand" } ] }, "docs": "When no supported content profile is explicitly set, the system uses the \"SMS Default\" profile. This default profile allows all media types (*/*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. The \"SMS Default\" profile does not have an ID and cannot be modified. To customize media filtering, create and assign a custom supported content profile." }, { "info": { "name": "Provision a phone number for SMS", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/sms/phonenumbers" }, "docs": "When provisioning an MMS-capable phone number, if no supported content profile is specified in the request, the system automatically assigns the \"SMS Default\" profile. This default profile allows all media types (*/*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. To use custom media filtering, specify a supported content profile ID in the request body." }, { "info": { "name": "Retrieve a single predictor.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/predictors/:predictorId", "params": [ { "name": "predictorId", "value": "", "type": "path", "description": "Predictor ID" } ] }, "docs": "Retrieve a single predictor." }, { "info": { "name": "Update single predictor.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/routing/predictors/:predictorId", "params": [ { "name": "predictorId", "value": "", "type": "path", "description": "Predictor ID" } ] }, "docs": "Update single predictor." }, { "info": { "name": "Delete single predictor.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/routing/predictors/:predictorId", "params": [ { "name": "predictorId", "value": "", "type": "path", "description": "Predictor ID" } ] }, "docs": "Delete single predictor." }, { "info": { "name": "Retrieve all predictors.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/predictors", "params": [ { "name": "before", "value": "", "type": "query", "description": "The cursor that points to the start of the set of entities that has been returned." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "limit", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 200. Deprecated in favour of pageSize" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 200." }, { "name": "queueId", "value": "", "type": "query", "description": "Comma-separated list of queue Ids to filter by." }, { "name": "kpiId", "value": "", "type": "query", "description": "Standard or custom KPI id used to filter predictors." }, { "name": "state", "value": "", "type": "query", "description": "The state used to filter predictors." } ] }, "docs": "Retrieve all predictors." }, { "info": { "name": "Create a predictor.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/predictors" }, "docs": "Create a predictor." }, { "info": { "name": "Get a list of Key Performance Indicators", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/predictors/keyperformanceindicators", "params": [ { "name": "kpiGroup", "value": "", "type": "query", "description": "The Group of Key Performance Indicators to return" }, { "name": "expand", "value": "", "type": "query", "description": "Parameter to request additional data to return in KPI payload" } ] }, "docs": "Get a list of Key Performance Indicators" }, { "info": { "name": "Retrieve Predictor Model Features.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/predictors/:predictorId/models/:modelId/features", "params": [ { "name": "predictorId", "value": "", "type": "path", "description": "Predictor ID" }, { "name": "modelId", "value": "", "type": "path", "description": "Model ID" } ] }, "docs": "Retrieve Predictor Model Features." }, { "info": { "name": "Retrieve Predictor Models and Top Features.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/predictors/:predictorId/models", "params": [ { "name": "predictorId", "value": "", "type": "path", "description": "Predictor ID" } ] }, "docs": "Retrieve Predictor Models and Top Features." }, { "info": { "name": "Update the ring number OR joined status for a queue member.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/routing/queues/:queueId/members/:memberId", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "Queue ID" }, { "name": "memberId", "value": "", "type": "path", "description": "Member ID" } ] }, "docs": "Update the ring number OR joined status for a queue member." }, { "info": { "name": "Delete a queue member.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/routing/queues/:queueId/members/:memberId", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "Queue ID" }, { "name": "memberId", "value": "", "type": "path", "description": "Member ID" } ] }, "docs": "Delete a queue member." }, { "info": { "name": "Get the members of this queue.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/queues/:queueId/members", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "Queue ID" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query", "description": "Max value is 100" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Note: results are sorted by name." }, { "name": "expand", "value": "", "type": "query", "description": "Which fields, if any, to expand." }, { "name": "name", "value": "", "type": "query", "description": "Filter by queue member name (contains-style search)" }, { "name": "profileSkills", "value": "", "type": "query", "description": "Filter by profile skill (contains-style search)" }, { "name": "skills", "value": "", "type": "query", "description": "Filter by skill (contains-style search)" }, { "name": "languages", "value": "", "type": "query", "description": "Filter by language (contains-style search)" }, { "name": "routingStatus", "value": "", "type": "query", "description": "Filter by routing status" }, { "name": "presence", "value": "", "type": "query", "description": "Filter by presence" }, { "name": "memberBy", "value": "", "type": "query", "description": "Filter by member type" }, { "name": "joined", "value": "", "type": "query", "description": "Filter by joined status" } ] }, "docs": "Get the members of this queue." }, { "info": { "name": "Bulk add or delete up to 100 queue members", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/queues/:queueId/members", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "Queue ID" }, { "name": "delete", "value": "", "type": "query", "description": "True to delete queue members" } ] }, "docs": "Bulk add or delete up to 100 queue members" }, { "info": { "name": "Join or unjoin a set of up to 100 users for a queue", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/routing/queues/:queueId/members", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "Queue ID" } ] }, "docs": "Users can only be joined to queues where they have membership. Non-member user-queue pairs in the request will be disregarded. Note: This operation is processed asynchronously and the response data may not reflect the final state. Changes may take time to propagate. Query the GET endpoint after a delay to retrieve the current membership status." }, { "info": { "name": "DEPRECATED: use PATCH /routing/queues/{queueId}/members/{memberId}. Update the ring number OR joined status for a User in a Queue.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/routing/queues/:queueId/users/:memberId", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "Queue ID" }, { "name": "memberId", "value": "", "type": "path", "description": "Member ID" } ] }, "docs": "DEPRECATED: use PATCH /routing/queues/{queueId}/members/{memberId}. Update the ring number OR joined status for a User in a Queue." }, { "info": { "name": "DEPRECATED: use DELETE /routing/queues/{queueId}/members/{memberId}. Delete queue member.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/routing/queues/:queueId/users/:memberId", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "Queue ID" }, { "name": "memberId", "value": "", "type": "path", "description": "Member ID" } ] }, "docs": "DEPRECATED: use DELETE /routing/queues/{queueId}/members/{memberId}. Delete queue member." }, { "info": { "name": "DEPRECATED: use GET /routing/queues/{queueId}/members. Get the members of this queue.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/queues/:queueId/users", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "Queue ID" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query", "description": "Max value is 100" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Note: results are sorted by name." }, { "name": "expand", "value": "", "type": "query", "description": "Which fields, if any, to expand." }, { "name": "joined", "value": "", "type": "query", "description": "Filter by joined status" }, { "name": "name", "value": "", "type": "query", "description": "Filter by queue member name" }, { "name": "profileSkills", "value": "", "type": "query", "description": "Filter by profile skill" }, { "name": "skills", "value": "", "type": "query", "description": "Filter by skill" }, { "name": "languages", "value": "", "type": "query", "description": "Filter by language" }, { "name": "routingStatus", "value": "", "type": "query", "description": "Filter by routing status" }, { "name": "presence", "value": "", "type": "query", "description": "Filter by presence" } ] }, "docs": "DEPRECATED: use GET /routing/queues/{queueId}/members. Get the members of this queue." }, { "info": { "name": "DEPRECATED: use POST /routing/queues/{queueId}/members. Bulk add or delete up to 100 queue members.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/queues/:queueId/users", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "Queue ID" }, { "name": "delete", "value": "", "type": "query", "description": "True to delete queue members" } ] }, "docs": "DEPRECATED: use POST /routing/queues/{queueId}/members. Bulk add or delete up to 100 queue members." }, { "info": { "name": "DEPRECATED: use PATCH /routing/queues/{queueId}/members. Join or unjoin a set of users for a queue.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/routing/queues/:queueId/users", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "Queue ID" } ] }, "docs": "DEPRECATED: use PATCH /routing/queues/{queueId}/members. Join or unjoin a set of users for a queue." }, { "info": { "name": "Get an assistant associated with a queue.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/queues/:queueId/assistant", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "Queue ID" }, { "name": "expand", "value": "", "type": "query", "description": "Which fields, if any, to expand." }, { "name": "languageVariation", "value": "", "type": "query", "description": "Language variation" }, { "name": "fallbackToPrimaryAssistant", "value": "", "type": "query", "description": "Fall back to primary assistant if specified variation is not found" } ] }, "docs": "Get an assistant associated with a queue." }, { "info": { "name": "Get a Comparison Period.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/queues/:queueId/comparisonperiods/:comparisonPeriodId", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "Queue id" }, { "name": "comparisonPeriodId", "value": "", "type": "path", "description": "ComparisonPeriod id" } ] }, "docs": "Get a Comparison Period." }, { "info": { "name": "Get list of comparison periods", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/queues/:queueId/comparisonperiods", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "Queue id" } ] }, "docs": "Get list of comparison periods" }, { "info": { "name": "Get a skill expression by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/skillexpressions/:expressionId", "params": [ { "name": "expressionId", "value": "", "type": "path", "description": "Expression ID" }, { "name": "includeArchived", "value": "", "type": "query", "description": "Include archived" }, { "name": "format", "value": "", "type": "query", "description": "Response format: raw expression or normalized" } ] }, "docs": "Get a skill expression by ID" }, { "info": { "name": "Archive a skill expression to remove it from the set of active expressions", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/routing/skillexpressions/:expressionId", "params": [ { "name": "expressionId", "value": "", "type": "path", "description": "Expression ID" } ] }, "docs": "Archive a skill expression to remove it from the set of active expressions" }, { "info": { "name": "Validate and normalize a skill expression", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/skillexpressions/validate" }, "docs": "Validate and normalize a skill expression" }, { "info": { "name": "Get skill expressions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/skillexpressions", "params": [ { "name": "format", "value": "", "type": "query", "description": "Response format: raw expression or normalized" }, { "name": "includeArchived", "value": "", "type": "query", "description": "Include archived" }, { "name": "id", "value": "", "type": "query", "description": "Expression ID(s) to filter. Repeat for multiple or use comma-separated list." } ] }, "docs": "Get skill expressions" }, { "info": { "name": "Archive a set of skill expressions to remove them from the set of active expressions", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/routing/skillexpressions", "params": [ { "name": "id", "value": "", "type": "query", "description": "Expression ID(s) to filter. Repeat for multiple or use comma-separated list." } ] }, "docs": "Archive a set of skill expressions to remove them from the set of active expressions" }, { "info": { "name": "Get skill expressions associated with a queue", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/skillexpressions/queue/:queueId", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "Queue ID" }, { "name": "format", "value": "", "type": "query", "description": "Response format: raw expression or normalized" }, { "name": "includeArchived", "value": "", "type": "query", "description": "Include archived" } ] }, "docs": "Get skill expressions associated with a queue" }, { "info": { "name": "Get list of member divisions for this skill group.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/skillgroups/:skillGroupId/members/divisions", "params": [ { "name": "skillGroupId", "value": "", "type": "path", "description": "Skill Group ID" }, { "name": "expand", "value": "", "type": "query", "description": "Expand the name on each user" } ] }, "docs": "Get list of member divisions for this skill group." }, { "info": { "name": "Add or remove member divisions for this skill group.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/skillgroups/:skillGroupId/members/divisions", "params": [ { "name": "skillGroupId", "value": "", "type": "path", "description": "Skill Group ID" } ] }, "docs": "Add or remove member divisions for this skill group." }, { "info": { "name": "Get skill group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/skillgroups/:skillGroupId", "params": [ { "name": "skillGroupId", "value": "", "type": "path", "description": "Skill Group ID" } ] }, "docs": "Get skill group" }, { "info": { "name": "Update skill group definition", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/routing/skillgroups/:skillGroupId", "params": [ { "name": "skillGroupId", "value": "", "type": "path", "description": "Skill Group ID" } ] }, "docs": "Update skill group definition" }, { "info": { "name": "Remove skill group definition", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/routing/skillgroups/:skillGroupId", "params": [ { "name": "skillGroupId", "value": "", "type": "path", "description": "Skill Group ID" } ] }, "docs": "Remove skill group definition" }, { "info": { "name": "Get skill group members", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/skillgroups/:skillGroupId/members", "params": [ { "name": "skillGroupId", "value": "", "type": "path", "description": "Skill Group ID" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the next item" }, { "name": "before", "value": "", "type": "query", "description": "The cursor that points to the previous item" }, { "name": "expand", "value": "", "type": "query", "description": "Expand the name on each user" } ] }, "docs": "Get skill group members" }, { "info": { "name": "Get skill group listing", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/skillgroups", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "name", "value": "", "type": "query", "description": "Return only skill group names whose names start with this value (case-insensitive matching)" }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the next item" }, { "name": "before", "value": "", "type": "query", "description": "The cursor that points to the previous item" } ] }, "docs": "Get skill group listing" }, { "info": { "name": "Create a skill group", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/skillgroups" }, "docs": "Create a skill group" }, { "info": { "name": "Get the user's Direct Routing Backup settings.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/directroutingbackup/settings/me" }, "docs": "Get the user's Direct Routing Backup settings." }, { "info": { "name": "Update the user's Direct Routing Backup settings.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/routing/directroutingbackup/settings/me" }, "docs": "Update the user's Direct Routing Backup settings." }, { "info": { "name": "Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/routing/directroutingbackup/settings/me" }, "docs": "Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default." }, { "info": { "name": "Get the user's Direct Routing Backup settings.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/users/:userId/directroutingbackup/settings", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User ID" } ] }, "docs": "Get the user's Direct Routing Backup settings." }, { "info": { "name": "Update the user's Direct Routing Backup settings.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/routing/users/:userId/directroutingbackup/settings", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User ID" } ] }, "docs": "Update the user's Direct Routing Backup settings." }, { "info": { "name": "Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/routing/users/:userId/directroutingbackup/settings", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User ID" } ] }, "docs": "Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default." }, { "info": { "name": "Get the user's max utilization settings. If not configured, the organization-wide default is returned.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/users/:userId/utilization", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User ID" } ] }, "docs": "Get the user's max utilization settings. If not configured, the organization-wide default is returned." }, { "info": { "name": "Update the user's max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the organization's default values.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/routing/users/:userId/utilization", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User ID" } ] }, "docs": "Update the user's max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the organization's default values." }, { "info": { "name": "Delete the user's max utilization settings and revert to the organization-wide default.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/routing/users/:userId/utilization", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User ID" } ] }, "docs": "Delete the user's max utilization settings and revert to the organization-wide default." }, { "info": { "name": "Get a simplified wrap-up code.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/wrapupcodes/divisionviews/:codeId", "params": [ { "name": "codeId", "value": "", "type": "path", "description": "Wrapup Code ID" } ] }, "docs": "Get a simplified wrap-up code." }, { "info": { "name": "Get a paged listing of simplified wrapup code objects, filterable by name, wrapup code ID(s), or division ID(s).", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/wrapupcodes/divisionviews", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "name", "value": "", "type": "query", "description": "Name (trailing asterisks allowed)" }, { "name": "id", "value": "", "type": "query", "description": "Wrapup code ID(s)" }, { "name": "divisionId", "value": "", "type": "query", "description": "Division ID(s)" }, { "name": "includeState", "value": "", "type": "query", "description": "Wrapup code state(s) to include" } ] }, "docs": "Specifying both name and ID parameters is not supported." }, { "info": { "name": "Get details about this wrap-up code.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/wrapupcodes/:codeId", "params": [ { "name": "codeId", "value": "", "type": "path", "description": "Wrapup Code ID" } ] }, "docs": "Get details about this wrap-up code." }, { "info": { "name": "Update wrap-up code", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/routing/wrapupcodes/:codeId", "params": [ { "name": "codeId", "value": "", "type": "path", "description": "Wrapup Code ID" } ] }, "docs": "Update wrap-up code" }, { "info": { "name": "Delete wrap-up code", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/routing/wrapupcodes/:codeId", "params": [ { "name": "codeId", "value": "", "type": "path", "description": "Wrapup Code ID" } ] }, "docs": "Delete wrap-up code" }, { "info": { "name": "Get list of wrapup codes.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/routing/wrapupcodes", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "name", "value": "", "type": "query", "description": "Wrapup code's name ('Sort by' param is ignored unless this field is provided)" }, { "name": "id", "value": "", "type": "query", "description": "Filter by wrapup code ID(s)" }, { "name": "divisionId", "value": "", "type": "query", "description": "Filter by division ID(s)" } ] }, "docs": "Get list of wrapup codes." }, { "info": { "name": "Create a wrap-up code", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/routing/wrapupcodes" }, "docs": "Create a wrap-up code" }, { "info": { "name": "Join or unjoin a queue for a user", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/users/:userId/queues/:queueId", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "Queue ID" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ] }, "docs": "Join or unjoin a queue for a user" }, { "info": { "name": "Get queues for user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/users/:userId/queues", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User ID" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "joined", "value": "", "type": "query", "description": "Is joined to the queue" }, { "name": "divisionId", "value": "", "type": "query", "description": "Division ID(s)" } ] }, "docs": "Get queues for user" }, { "info": { "name": "Join or unjoin a set of queues for a user", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/users/:userId/queues", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User ID" }, { "name": "divisionId", "value": "", "type": "query", "description": "Division ID(s)" } ] }, "docs": "Users can only be joined to queues where they have membership. Non-member user-queue pairs in the request will be disregarded. Note: This operation is processed asynchronously and the response data may not reflect the final state. Changes may take time to propagate. Query the GET endpoint after a delay to retrieve the current membership status." }, { "info": { "name": "Update an assigned routing language's proficiency", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/users/:userId/routinglanguages/:languageId", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User ID" }, { "name": "languageId", "value": "", "type": "path", "description": "languageId" } ] }, "docs": "Update an assigned routing language's proficiency" }, { "info": { "name": "Remove a routing language from a user", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/users/:userId/routinglanguages/:languageId", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User ID" }, { "name": "languageId", "value": "", "type": "path", "description": "languageId" } ] }, "docs": "Remove a routing language from a user" }, { "info": { "name": "List routing languages assigned to a user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/users/:userId/routinglanguages", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User ID" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Ascending or descending sort order" } ] }, "docs": "List routing languages assigned to a user" }, { "info": { "name": "Assign a routing language to a user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/users/:userId/routinglanguages", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User ID" } ] }, "docs": "Assign a routing language to a user" }, { "info": { "name": "Assign multiple routing languages to a user. Max 50 routing languages in request body", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/users/:userId/routinglanguages/bulk", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User ID" } ] }, "docs": "Assign multiple routing languages to a user. Max 50 routing languages in request body" }, { "info": { "name": "Update an assigned routing skill's proficiency", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/users/:userId/routingskills/:skillId", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User ID" }, { "name": "skillId", "value": "", "type": "path", "description": "skillId" } ] }, "docs": "Update an assigned routing skill's proficiency" }, { "info": { "name": "Remove a routing skill from a user", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/users/:userId/routingskills/:skillId", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User ID" }, { "name": "skillId", "value": "", "type": "path", "description": "skillId" } ] }, "docs": "Remove a routing skill from a user" }, { "info": { "name": "List routing skills assigned to a user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/users/:userId/routingskills", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User ID" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Ascending or descending sort order" } ] }, "docs": "List routing skills assigned to a user" }, { "info": { "name": "Assign a routing skill to a user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/users/:userId/routingskills", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User ID" } ] }, "docs": "Assign a routing skill to a user" }, { "info": { "name": "Assign multiple routing skills to a user, replacing any current assignments", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/users/:userId/routingskills/bulk", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User ID" } ] }, "docs": "Assign multiple routing skills to a user, replacing any current assignments" }, { "info": { "name": "Assign multiple routing skills to a user", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/users/:userId/routingskills/bulk", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User ID" } ] }, "docs": "Assign multiple routing skills to a user" }, { "info": { "name": "Get skill groups for a user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/users/:userId/skillgroups", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User ID" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the next page" }, { "name": "before", "value": "", "type": "query", "description": "The cursor that points to the previous page" } ] }, "docs": "Get skill groups for a user" } ] } ], "bundled": true }