--- title: RoutingApi --- ## PureCloud::RoutingApi All URIs are relative to *https://api.mypurecloud.com* Method | HTTP request | Description ------------- | ------------- | ------------- |[**delete_email_domains_domain_id**](RoutingApi.html#delete_email_domains_domain_id) | **DELETE** /api/v2/routing/email/domains/{domainId} | Delete a domain| |[**delete_email_domains_domainname_routes_route_id**](RoutingApi.html#delete_email_domains_domainname_routes_route_id) | **DELETE** /api/v2/routing/email/domains/{domainName}/routes/{routeId} | Delete a route| |[**delete_queues_queue_id**](RoutingApi.html#delete_queues_queue_id) | **DELETE** /api/v2/routing/queues/{queueId} | Delete a queue| |[**delete_queues_queue_id_users_member_id**](RoutingApi.html#delete_queues_queue_id_users_member_id) | **DELETE** /api/v2/routing/queues/{queueId}/users/{memberId} | Delete queue member| |[**delete_queues_queue_id_wrapupcodes_code_id**](RoutingApi.html#delete_queues_queue_id_wrapupcodes_code_id) | **DELETE** /api/v2/routing/queues/{queueId}/wrapupcodes/{codeId} | Delete a wrap-up code from a queue| |[**delete_skills_skill_id**](RoutingApi.html#delete_skills_skill_id) | **DELETE** /api/v2/routing/skills/{skillId} | Delete Routing Skill| |[**delete_user_id_routingskills_skill_id**](RoutingApi.html#delete_user_id_routingskills_skill_id) | **DELETE** /api/v2/users/{userId}/routingskills/{skillId} | Remove routing skill from user| |[**delete_utilization**](RoutingApi.html#delete_utilization) | **DELETE** /api/v2/routing/utilization | Delete utilization settings and revert to system defaults.| |[**delete_wrapupcodes_code_id**](RoutingApi.html#delete_wrapupcodes_code_id) | **DELETE** /api/v2/routing/wrapupcodes/{codeId} | Delete wrap-up code| |[**get_email_domains**](RoutingApi.html#get_email_domains) | **GET** /api/v2/routing/email/domains | Get domains| |[**get_email_domains_domainname_routes**](RoutingApi.html#get_email_domains_domainname_routes) | **GET** /api/v2/routing/email/domains/{domainName}/routes | Get routes| |[**get_email_domains_domainname_routes_route_id**](RoutingApi.html#get_email_domains_domainname_routes_route_id) | **GET** /api/v2/routing/email/domains/{domainName}/routes/{routeId} | Get a route| |[**get_email_setup**](RoutingApi.html#get_email_setup) | **GET** /api/v2/routing/email/setup | Get email setup| |[**get_queues**](RoutingApi.html#get_queues) | **GET** /api/v2/routing/queues | Get list of queues.| |[**get_queues_queue_id**](RoutingApi.html#get_queues_queue_id) | **GET** /api/v2/routing/queues/{queueId} | Get details about this queue.| |[**get_queues_queue_id_estimatedwaittime**](RoutingApi.html#get_queues_queue_id_estimatedwaittime) | **GET** /api/v2/routing/queues/{queueId}/estimatedwaittime | Get Estimated Wait Time| |[**get_queues_queue_id_users**](RoutingApi.html#get_queues_queue_id_users) | **GET** /api/v2/routing/queues/{queueId}/users | Get the members of this queue| |[**get_queues_queue_id_wrapupcodes**](RoutingApi.html#get_queues_queue_id_wrapupcodes) | **GET** /api/v2/routing/queues/{queueId}/wrapupcodes | Get the wrap-up codes for a queue| |[**get_skills**](RoutingApi.html#get_skills) | **GET** /api/v2/routing/skills | Get the list of routing skills.| |[**get_skills_skill_id**](RoutingApi.html#get_skills_skill_id) | **GET** /api/v2/routing/skills/{skillId} | Get Routing Skill| |[**get_user_id_routingskills**](RoutingApi.html#get_user_id_routingskills) | **GET** /api/v2/users/{userId}/routingskills | List routing skills for user| |[**get_utilization**](RoutingApi.html#get_utilization) | **GET** /api/v2/routing/utilization | Get the utilization settings.| |[**get_wrapupcodes**](RoutingApi.html#get_wrapupcodes) | **GET** /api/v2/routing/wrapupcodes | Get list of wrapup codes.| |[**get_wrapupcodes_code_id**](RoutingApi.html#get_wrapupcodes_code_id) | **GET** /api/v2/routing/wrapupcodes/{codeId} | Get details about this wrap-up code.| |[**patch_queues_queue_id_users**](RoutingApi.html#patch_queues_queue_id_users) | **PATCH** /api/v2/routing/queues/{queueId}/users | Join or unjoin a set of users for a queue| |[**patch_queues_queue_id_users_member_id**](RoutingApi.html#patch_queues_queue_id_users_member_id) | **PATCH** /api/v2/routing/queues/{queueId}/users/{memberId} | Update the ring number of joined status for a User in a Queue| |[**post_email_domains**](RoutingApi.html#post_email_domains) | **POST** /api/v2/routing/email/domains | Create a domain| |[**post_email_domains_domainname_routes**](RoutingApi.html#post_email_domains_domainname_routes) | **POST** /api/v2/routing/email/domains/{domainName}/routes | Create a route| |[**post_queues**](RoutingApi.html#post_queues) | **POST** /api/v2/routing/queues | Create queue| |[**post_queues_observations_query**](RoutingApi.html#post_queues_observations_query) | **POST** /api/v2/analytics/queues/observations/query | Query for queue observations| |[**post_queues_queue_id_users**](RoutingApi.html#post_queues_queue_id_users) | **POST** /api/v2/routing/queues/{queueId}/users | Bulk add or delete up to 100 queue members| |[**post_queues_queue_id_wrapupcodes**](RoutingApi.html#post_queues_queue_id_wrapupcodes) | **POST** /api/v2/routing/queues/{queueId}/wrapupcodes | Add up to 100 wrap-up codes to a queue| |[**post_skills**](RoutingApi.html#post_skills) | **POST** /api/v2/routing/skills | Create Skill| |[**post_user_id_routingskills**](RoutingApi.html#post_user_id_routingskills) | **POST** /api/v2/users/{userId}/routingskills | Add routing skill to user| |[**post_wrapupcodes**](RoutingApi.html#post_wrapupcodes) | **POST** /api/v2/routing/wrapupcodes | Create a wrap-up code| |[**put_email_domains_domainname_routes_route_id**](RoutingApi.html#put_email_domains_domainname_routes_route_id) | **PUT** /api/v2/routing/email/domains/{domainName}/routes/{routeId} | Update a route| |[**put_queues_queue_id**](RoutingApi.html#put_queues_queue_id) | **PUT** /api/v2/routing/queues/{queueId} | Update a queue| |[**put_user_id_routingskills_skill_id**](RoutingApi.html#put_user_id_routingskills_skill_id) | **PUT** /api/v2/users/{userId}/routingskills/{skillId} | Update routing skill proficiency or state.| |[**put_utilization**](RoutingApi.html#put_utilization) | **PUT** /api/v2/routing/utilization | Update the utilization settings.| |[**put_wrapupcodes_code_id**](RoutingApi.html#put_wrapupcodes_code_id) | **PUT** /api/v2/routing/wrapupcodes/{codeId} | Update wrap-up code| {: class="table table-striped"} ## -String** delete_email_domains_domain_id(domain_id) Delete a domain ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new domain_id = "domain_id_example" # String | domain ID begin #Delete a domain result = api_instance.delete_email_domains_domain_id(domain_id) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->delete_email_domains_domain_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **domain_id** | **String**| domain ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_email_domains_domainname_routes_route_id(domain_name, route_id) Delete a route ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new domain_name = "domain_name_example" # String | email domain route_id = "route_id_example" # String | route ID begin #Delete a route result = api_instance.delete_email_domains_domainname_routes_route_id(domain_name, route_id) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->delete_email_domains_domainname_routes_route_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **domain_name** | **String**| email domain | **route_id** | **String**| route ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_queues_queue_id(queue_id, opts) Delete a queue ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new queue_id = "queue_id_example" # String | Queue ID opts = { force_delete: true # BOOLEAN | } begin #Delete a queue result = api_instance.delete_queues_queue_id(queue_id, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->delete_queues_queue_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **queue_id** | **String**| Queue ID | **force_delete** | **BOOLEAN**| | [optional] {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_queues_queue_id_users_member_id(queue_id, member_id) Delete queue member ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new queue_id = "queue_id_example" # String | Queue ID member_id = "member_id_example" # String | Member ID begin #Delete queue member result = api_instance.delete_queues_queue_id_users_member_id(queue_id, member_id) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->delete_queues_queue_id_users_member_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **queue_id** | **String**| Queue ID | **member_id** | **String**| Member ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_queues_queue_id_wrapupcodes_code_id(queue_id, code_id) Delete a wrap-up code from a queue ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new queue_id = "queue_id_example" # String | Queue ID code_id = "code_id_example" # String | Code ID begin #Delete a wrap-up code from a queue result = api_instance.delete_queues_queue_id_wrapupcodes_code_id(queue_id, code_id) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->delete_queues_queue_id_wrapupcodes_code_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **queue_id** | **String**| Queue ID | **code_id** | **String**| Code ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_skills_skill_id(skill_id) Delete Routing Skill ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new skill_id = "skill_id_example" # String | Skill ID begin #Delete Routing Skill result = api_instance.delete_skills_skill_id(skill_id) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->delete_skills_skill_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **skill_id** | **String**| Skill ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_user_id_routingskills_skill_id(user_id, skill_id) Remove routing skill from user ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new user_id = "user_id_example" # String | User ID skill_id = "skill_id_example" # String | begin #Remove routing skill from user result = api_instance.delete_user_id_routingskills_skill_id(user_id, skill_id) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->delete_user_id_routingskills_skill_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **String**| User ID | **skill_id** | **String**| | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_utilization Delete utilization settings and revert to system defaults. ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new begin #Delete utilization settings and revert to system defaults. result = api_instance.delete_utilization p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->delete_utilization: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_wrapupcodes_code_id(code_id) Delete wrap-up code ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new code_id = "code_id_example" # String | Wrapup Code ID begin #Delete wrap-up code result = api_instance.delete_wrapupcodes_code_id(code_id) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->delete_wrapupcodes_code_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **code_id** | **String**| Wrapup Code ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**InboundDomainEntityListing**](InboundDomainEntityListing.html) get_email_domains Get domains ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new begin #Get domains result = api_instance.get_email_domains p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->get_email_domains: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type [**InboundDomainEntityListing**](InboundDomainEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**InboundRouteEntityListing**](InboundRouteEntityListing.html) get_email_domains_domainname_routes(domain_name) Get routes ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new domain_name = "domain_name_example" # String | email domain begin #Get routes result = api_instance.get_email_domains_domainname_routes(domain_name) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->get_email_domains_domainname_routes: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **domain_name** | **String**| email domain | {: class="table table-striped"} ### Return type [**InboundRouteEntityListing**](InboundRouteEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**InboundRoute**](InboundRoute.html) get_email_domains_domainname_routes_route_id(domain_name, route_id) Get a route ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new domain_name = "domain_name_example" # String | email domain route_id = "route_id_example" # String | route ID begin #Get a route result = api_instance.get_email_domains_domainname_routes_route_id(domain_name, route_id) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->get_email_domains_domainname_routes_route_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **domain_name** | **String**| email domain | **route_id** | **String**| route ID | {: class="table table-striped"} ### Return type [**InboundRoute**](InboundRoute.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**EmailSetup**](EmailSetup.html) get_email_setup Get email setup ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new begin #Get email setup result = api_instance.get_email_setup p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->get_email_setup: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type [**EmailSetup**](EmailSetup.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**QueueEntityListing**](QueueEntityListing.html) get_queues(opts) Get list of queues. ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new opts = { page_size: 25, # Integer | Page size page_number: 1, # Integer | Page number sort_by: "name", # String | Sort by name: "name_example", # String | Name active: true # BOOLEAN | Active } begin #Get list of queues. result = api_instance.get_queues(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->get_queues: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page_size** | **Integer**| Page size | [optional] [default to 25] **page_number** | **Integer**| Page number | [optional] [default to 1] **sort_by** | **String**| Sort by | [optional] [default to name] **name** | **String**| Name | [optional] **active** | **BOOLEAN**| Active | [optional] {: class="table table-striped"} ### Return type [**QueueEntityListing**](QueueEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Queue**](Queue.html) get_queues_queue_id(queue_id) Get details about this queue. ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new queue_id = "queue_id_example" # String | Queue ID begin #Get details about this queue. result = api_instance.get_queues_queue_id(queue_id) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->get_queues_queue_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **queue_id** | **String**| Queue ID | {: class="table table-striped"} ### Return type [**Queue**](Queue.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**EstimatedWaitTimePredictions**](EstimatedWaitTimePredictions.html) get_queues_queue_id_estimatedwaittime(queue_id, opts) Get Estimated Wait Time ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new queue_id = "queue_id_example" # String | queueId opts = { conversation_id: "conversation_id_example" # String | conversationId } begin #Get Estimated Wait Time result = api_instance.get_queues_queue_id_estimatedwaittime(queue_id, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->get_queues_queue_id_estimatedwaittime: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **queue_id** | **String**| queueId | **conversation_id** | **String**| conversationId | [optional] {: class="table table-striped"} ### Return type [**EstimatedWaitTimePredictions**](EstimatedWaitTimePredictions.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**QueueMember**](QueueMember.html) get_queues_queue_id_users(queue_id, opts) Get the members of this queue ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new queue_id = "queue_id_example" # String | Queue ID opts = { page_size: 25, # Integer | Page size page_number: 1, # Integer | Page number sort_by: "name", # String | Sort by expand: "expand_example", # String | expand direct_members: false # BOOLEAN | Only get users that are direct members of the queue } begin #Get the members of this queue result = api_instance.get_queues_queue_id_users(queue_id, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->get_queues_queue_id_users: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **queue_id** | **String**| Queue ID | **page_size** | **Integer**| Page size | [optional] [default to 25] **page_number** | **Integer**| Page number | [optional] [default to 1] **sort_by** | **String**| Sort by | [optional] [default to name] **expand** | **String**| expand | [optional] **direct_members** | **BOOLEAN**| Only get users that are direct members of the queue | [optional] [default to false] {: class="table table-striped"} ### Return type [**QueueMember**](QueueMember.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**WrapupCode**](WrapupCode.html) get_queues_queue_id_wrapupcodes(queue_id, code_id) Get the wrap-up codes for a queue ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new queue_id = "queue_id_example" # String | Queue ID code_id = "code_id_example" # String | Code ID begin #Get the wrap-up codes for a queue result = api_instance.get_queues_queue_id_wrapupcodes(queue_id, code_id) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->get_queues_queue_id_wrapupcodes: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **queue_id** | **String**| Queue ID | **code_id** | **String**| Code ID | {: class="table table-striped"} ### Return type [**WrapupCode**](WrapupCode.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**SkillEntityListing**](SkillEntityListing.html) get_skills(opts) Get the list of routing skills. ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new opts = { page_size: 25, # Integer | Page size page_number: 1 # Integer | Page number } begin #Get the list of routing skills. result = api_instance.get_skills(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->get_skills: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page_size** | **Integer**| Page size | [optional] [default to 25] **page_number** | **Integer**| Page number | [optional] [default to 1] {: class="table table-striped"} ### Return type [**SkillEntityListing**](SkillEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**RoutingSkill**](RoutingSkill.html) get_skills_skill_id(skill_id) Get Routing Skill ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new skill_id = "skill_id_example" # String | Skill ID begin #Get Routing Skill result = api_instance.get_skills_skill_id(skill_id) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->get_skills_skill_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **skill_id** | **String**| Skill ID | {: class="table table-striped"} ### Return type [**RoutingSkill**](RoutingSkill.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**UserSkillEntityListing**](UserSkillEntityListing.html) get_user_id_routingskills(user_id, opts) List routing skills for user ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new user_id = "user_id_example" # String | User ID opts = { page_size: 25, # Integer | Page size page_number: 1, # Integer | Page number sort_order: "ASC" # String | Ascending or descending sort order } begin #List routing skills for user result = api_instance.get_user_id_routingskills(user_id, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->get_user_id_routingskills: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **String**| User ID | **page_size** | **Integer**| Page size | [optional] [default to 25] **page_number** | **Integer**| Page number | [optional] [default to 1] **sort_order** | **String**| Ascending or descending sort order | [optional] [default to ASC] {: class="table table-striped"} ### Return type [**UserSkillEntityListing**](UserSkillEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Utilization**](Utilization.html) get_utilization Get the utilization settings. ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new begin #Get the utilization settings. result = api_instance.get_utilization p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->get_utilization: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type [**Utilization**](Utilization.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**WrapupCodeEntityListing**](WrapupCodeEntityListing.html) get_wrapupcodes(opts) Get list of wrapup codes. ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new opts = { page_size: 25, # Integer | Page size page_number: 1, # Integer | Page number sort_by: "name" # String | Sort by } begin #Get list of wrapup codes. result = api_instance.get_wrapupcodes(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->get_wrapupcodes: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page_size** | **Integer**| Page size | [optional] [default to 25] **page_number** | **Integer**| Page number | [optional] [default to 1] **sort_by** | **String**| Sort by | [optional] [default to name] {: class="table table-striped"} ### Return type [**WrapupCodeEntityListing**](WrapupCodeEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**WrapupCode**](WrapupCode.html) get_wrapupcodes_code_id(code_id) Get details about this wrap-up code. ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new code_id = "code_id_example" # String | Wrapup Code ID begin #Get details about this wrap-up code. result = api_instance.get_wrapupcodes_code_id(code_id) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->get_wrapupcodes_code_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **code_id** | **String**| Wrapup Code ID | {: class="table table-striped"} ### Return type [**WrapupCode**](WrapupCode.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**QueueMember**](QueueMember.html) patch_queues_queue_id_users(queue_id, body) Join or unjoin a set of users for a queue ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new queue_id = "queue_id_example" # String | Queue ID body = [PureCloud::QueueMember.new] # Array | Queue Members begin #Join or unjoin a set of users for a queue result = api_instance.patch_queues_queue_id_users(queue_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->patch_queues_queue_id_users: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **queue_id** | **String**| Queue ID | **body** | [**Array<QueueMember>**](QueueMember.html)| Queue Members | {: class="table table-striped"} ### Return type [**QueueMember**](QueueMember.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**QueueMember**](QueueMember.html) patch_queues_queue_id_users_member_id(queue_id, member_id, body) Update the ring number of joined status for a User in a Queue ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new queue_id = "queue_id_example" # String | Queue ID member_id = "member_id_example" # String | Member ID body = PureCloud::QueueMember.new # QueueMember | Queue Member begin #Update the ring number of joined status for a User in a Queue result = api_instance.patch_queues_queue_id_users_member_id(queue_id, member_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->patch_queues_queue_id_users_member_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **queue_id** | **String**| Queue ID | **member_id** | **String**| Member ID | **body** | [**QueueMember**](QueueMember.html)| Queue Member | {: class="table table-striped"} ### Return type [**QueueMember**](QueueMember.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**InboundDomain**](InboundDomain.html) post_email_domains(body) Create a domain ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new body = PureCloud::InboundDomain.new # InboundDomain | Domain begin #Create a domain result = api_instance.post_email_domains(body) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->post_email_domains: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**InboundDomain**](InboundDomain.html)| Domain | {: class="table table-striped"} ### Return type [**InboundDomain**](InboundDomain.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**InboundRoute**](InboundRoute.html) post_email_domains_domainname_routes(domain_name, body) Create a route ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new domain_name = "domain_name_example" # String | email domain body = PureCloud::InboundRoute.new # InboundRoute | Route begin #Create a route result = api_instance.post_email_domains_domainname_routes(domain_name, body) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->post_email_domains_domainname_routes: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **domain_name** | **String**| email domain | **body** | [**InboundRoute**](InboundRoute.html)| Route | {: class="table table-striped"} ### Return type [**InboundRoute**](InboundRoute.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Queue**](Queue.html) post_queues(body) Create queue ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new body = PureCloud::Queue.new # Queue | Queue begin #Create queue result = api_instance.post_queues(body) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->post_queues: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Queue**](Queue.html)| Queue | {: class="table table-striped"} ### Return type [**Queue**](Queue.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**ObservationQueryResponse**](ObservationQueryResponse.html) post_queues_observations_query(body) Query for queue observations ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new body = PureCloud::ObservationQuery.new # ObservationQuery | query begin #Query for queue observations result = api_instance.post_queues_observations_query(body) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->post_queues_observations_query: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**ObservationQuery**](ObservationQuery.html)| query | {: class="table table-striped"} ### Return type [**ObservationQueryResponse**](ObservationQueryResponse.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**QueueMember**](QueueMember.html) post_queues_queue_id_users(queue_id, body, opts) Bulk add or delete up to 100 queue members ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new queue_id = "queue_id_example" # String | Queue ID body = [PureCloud::QueueMember.new] # Array | Queue Members opts = { delete: false # BOOLEAN | True to delete queue members } begin #Bulk add or delete up to 100 queue members result = api_instance.post_queues_queue_id_users(queue_id, body, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->post_queues_queue_id_users: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **queue_id** | **String**| Queue ID | **body** | [**Array<QueueMember>**](QueueMember.html)| Queue Members | **delete** | **BOOLEAN**| True to delete queue members | [optional] [default to false] {: class="table table-striped"} ### Return type [**QueueMember**](QueueMember.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**WrapupCode**](WrapupCode.html) post_queues_queue_id_wrapupcodes(queue_id, code_id, body) Add up to 100 wrap-up codes to a queue ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new queue_id = "queue_id_example" # String | Queue ID code_id = "code_id_example" # String | Code ID body = [PureCloud::WrapupCode.new] # Array | List of wrapup codes begin #Add up to 100 wrap-up codes to a queue result = api_instance.post_queues_queue_id_wrapupcodes(queue_id, code_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->post_queues_queue_id_wrapupcodes: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **queue_id** | **String**| Queue ID | **code_id** | **String**| Code ID | **body** | [**Array<WrapupCode>**](WrapupCode.html)| List of wrapup codes | {: class="table table-striped"} ### Return type [**WrapupCode**](WrapupCode.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**RoutingSkill**](RoutingSkill.html) post_skills(body) Create Skill ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new body = PureCloud::RoutingSkill.new # RoutingSkill | Skill begin #Create Skill result = api_instance.post_skills(body) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->post_skills: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**RoutingSkill**](RoutingSkill.html)| Skill | {: class="table table-striped"} ### Return type [**RoutingSkill**](RoutingSkill.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**UserRoutingSkill**](UserRoutingSkill.html) post_user_id_routingskills(user_id, body) Add routing skill to user ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new user_id = "user_id_example" # String | User ID body = PureCloud::UserRoutingSkill.new # UserRoutingSkill | Skill begin #Add routing skill to user result = api_instance.post_user_id_routingskills(user_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->post_user_id_routingskills: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **String**| User ID | **body** | [**UserRoutingSkill**](UserRoutingSkill.html)| Skill | {: class="table table-striped"} ### Return type [**UserRoutingSkill**](UserRoutingSkill.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**CallableTimeSet**](CallableTimeSet.html) post_wrapupcodes(body) Create a wrap-up code ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new body = PureCloud::WrapupCode.new # WrapupCode | WrapupCode begin #Create a wrap-up code result = api_instance.post_wrapupcodes(body) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->post_wrapupcodes: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**WrapupCode**](WrapupCode.html)| WrapupCode | {: class="table table-striped"} ### Return type [**CallableTimeSet**](CallableTimeSet.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**InboundRoute**](InboundRoute.html) put_email_domains_domainname_routes_route_id(domain_name, route_id, body) Update a route ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new domain_name = "domain_name_example" # String | email domain route_id = "route_id_example" # String | route ID body = PureCloud::InboundRoute.new # InboundRoute | Route begin #Update a route result = api_instance.put_email_domains_domainname_routes_route_id(domain_name, route_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->put_email_domains_domainname_routes_route_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **domain_name** | **String**| email domain | **route_id** | **String**| route ID | **body** | [**InboundRoute**](InboundRoute.html)| Route | {: class="table table-striped"} ### Return type [**InboundRoute**](InboundRoute.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Queue**](Queue.html) put_queues_queue_id(queue_id, body) Update a queue ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new queue_id = "queue_id_example" # String | Queue ID body = PureCloud::Queue.new # Queue | Queue begin #Update a queue result = api_instance.put_queues_queue_id(queue_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->put_queues_queue_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **queue_id** | **String**| Queue ID | **body** | [**Queue**](Queue.html)| Queue | {: class="table table-striped"} ### Return type [**Queue**](Queue.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**UserRoutingSkill**](UserRoutingSkill.html) put_user_id_routingskills_skill_id(user_id, skill_id, body) Update routing skill proficiency or state. ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new user_id = "user_id_example" # String | User ID skill_id = "skill_id_example" # String | body = PureCloud::UserRoutingSkill.new # UserRoutingSkill | Skill begin #Update routing skill proficiency or state. result = api_instance.put_user_id_routingskills_skill_id(user_id, skill_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->put_user_id_routingskills_skill_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **String**| User ID | **skill_id** | **String**| | **body** | [**UserRoutingSkill**](UserRoutingSkill.html)| Skill | {: class="table table-striped"} ### Return type [**UserRoutingSkill**](UserRoutingSkill.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Utilization**](Utilization.html) put_utilization(body) Update the utilization settings. ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new body = PureCloud::Utilization.new # Utilization | utilization begin #Update the utilization settings. result = api_instance.put_utilization(body) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->put_utilization: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Utilization**](Utilization.html)| utilization | {: class="table table-striped"} ### Return type [**Utilization**](Utilization.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**WrapupCode**](WrapupCode.html) put_wrapupcodes_code_id(code_id, body) Update wrap-up code ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] environment = "mypurecloud.com" @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment PureCloud.configure do |config| config.access_token = @authToken end api_instance = PureCloud::RoutingApi.new code_id = "code_id_example" # String | Wrapup Code ID body = PureCloud::WrapupCode.new # WrapupCode | WrapupCode begin #Update wrap-up code result = api_instance.put_wrapupcodes_code_id(code_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling RoutingApi->put_wrapupcodes_code_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **code_id** | **String**| Wrapup Code ID | **body** | [**WrapupCode**](WrapupCode.html)| WrapupCode | {: class="table table-striped"} ### Return type [**WrapupCode**](WrapupCode.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json