InContact API

A gem for the InContact API

Add the gem to your Gemfile:

gem 'incontact_api'

Or

gem install incontact_api

Define the following as enviroment variables.

UCN_URL

UCN_KEY

GRANT_TYPE

USERNAME

PASSWORD

SCOPE

If you are using rails you could use the Figaro gem to handle setting up environment variables.

UCN_URL: This is the base url 'https://api.incontact.com'

UCN_KEY: This is a key that is made up of Application Name@Vendor Name:Business # EX. 'MyApp@MyCompany:12345'

GRANT_TYPE: This variable is based on the types of API you request. More info can be found below in the link

USERNAME: The username to use to access the API. User must have permissions to create API Applications

PASSWORD: The password for the above username.

SCOPE: The list of API's you want to access. Format to a string for example "Admin Chat RealTime"

• See important note below on the SCOPE variable

Link to InContacts API

Starting April 28th InContact will be changing the string format that can be passed to the SCOPE variable.

Proper string format below:

• RealTimeApi
• AdminApi
• AgentApi
• CustomApi
• AuthenticationApi
• PatronApi (this is only available in 14.1 and replaces the ChatApi)
• ChatApi (this is valid in 13.2 and is translated into PatronApi when passed in 14.1)

Returns list of agents

require 'incontact_api'

InContactApi::Connection.base.get "/inContactAPI/services/v2.0/agents"