Salesforce Live Chat Agent API
This is a backend API service which connects to the Salesforce Live Chat Agent resources. https://developer.salesforce.com/docs/atlas.en-us.live_agent_rest.meta/live_agent_rest/live_agent_rest_understanding_resources.htm
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Prerequisites
Node v8.11.3 or greater. This can be installed via nvm.
NVM installation
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.34.0/install.sh | bash
Installing
Install all node packages via npm.
In the root of the project.
npm install @javiguajardo/salesforce-live-agent
Usage
const SalesForceLiveAgent = require('@javiguajardo/salesforce-live-agent');
const salesForceLiveAgent = new SalesForceLiveAgent();
// Poll for incoming messages from a salesforce live agent.
salesForceLiveAgent.pollMessages(sesssionAttributes)
.then((messages) => {
console.log(messages);
})
.catch((error) => {
console.log(error);
});
// Post a message to a salesforce live agent.
salesForceLiveAgent.postChatMessage(sessionAttributes, "hello")
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});Running the tests
Run npm test in the root of the project.