Alvaria Cloud Customer Experience Context Cookies REST API v2.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Overview

The Alvaria™ Cloud Customer Experience REST API, provided by the CX Continuity Server, facilitates easy integration with other systems by providing access to Context Cookies stored in the underlying database. This enables you to, for example:

• Pre-populate Context Cookies with information derived from CRM systems.
• Share Context Cookies with third-party systems.
• Run scheduled maintenance operations on the Context Cookies repository to clean out entries that are no longer needed.

In order to utilize the Customer Experience REST API the customerexperienceapi scope is required.

Base URLs:

• https://orgId.via.aspect-cloud.net

License: License: Creative Commons Attribution 4.0 International Public License

Authentication

• oAuth2 authentication.

  • Flow: client crendentials
  • Authorization URL = https://myaspect.{region}.id.aspect-cloud.net/tokenservice/oauth2/access_token

Settings

Get Settings

Code samples

# You can also use wget
curl -X GET https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/customerexperience/contextCookies/settings \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'x-api-key: string'

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'x-api-key':'string'
};

fetch('https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/customerexperience/contextCookies/settings',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/customerexperience/contextCookies/settings HTTP/1.1
Host: orgid.via.aspect-cloud.net
Accept: application/json
Authorization: string
x-api-key: string

GET /via/v2/organizations/{orgId}/customerexperience/contextCookies/settings

Returns all settings matching the filters

Parameters

Example responses

200 Response

{
  "kind": "cxp#contextCookiesSettingCollection",
  "settings": [
    {
      "customerId": "a",
      "key": "key1",
      "content": "content1",
      "channel": "all",
      "service": "a",
      "expiresOnTime": "2017-05-24T13:35:28.000Z",
      "creationTime": "2017-05-24T13:35:28.000Z",
      "lastModifiedTime": "2017-05-24T13:35:28.000Z"
    }
  ],
  "totalItems": "1"
}

Responses

Delete Settings

Code samples

# You can also use wget
curl -X DELETE https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/customerexperience/contextCookies/settings \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'x-api-key: string'

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'x-api-key':'string'
};

fetch('https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/customerexperience/contextCookies/settings',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/customerexperience/contextCookies/settings HTTP/1.1
Host: orgid.via.aspect-cloud.net
Accept: application/json
Authorization: string
x-api-key: string

DELETE /via/v2/organizations/{orgId}/customerexperience/contextCookies/settings

Deletes the settings that match the filters

Parameters

Example responses

400 Response

{
  "code": "400",
  "message": "Validation exception",
  "errors": [
    {
      "scope": "global",
      "reason": "Invalid request",
      "message": "The value for the channel is invalid"
    }
  ]
}

Responses

Post Settings

Code samples

# You can also use wget
curl -X POST https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/customerexperience/contextCookies/settings \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'x-api-key: string'

const fetch = require('node-fetch');
const inputBody = {
  "settings": [
    {
      "customerId": "a",
      "key": "key1",
      "content": "content1",
      "channel": "voice",
      "service": "b",
      "expiresOnTime": "2017-05-24T13:35:28.000Z"
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'string',
  'x-api-key':'string'
};

fetch('https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/customerexperience/contextCookies/settings',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/customerexperience/contextCookies/settings HTTP/1.1
Host: orgid.via.aspect-cloud.net
Content-Type: application/json
Accept: application/json
Authorization: string
x-api-key: string

POST /via/v2/organizations/{orgId}/customerexperience/contextCookies/settings

Creates or modifies settings for the customer. The POST method is transactional, which means that either all settings in the payload are created or updated or none of the settings. A failure to create or update one setting results in a complete rollback

Body parameter

{
  "settings": [
    {
      "customerId": "a",
      "key": "key1",
      "content": "content1",
      "channel": "voice",
      "service": "b",
      "expiresOnTime": "2017-05-24T13:35:28.000Z"
    }
  ]
}

Parameters

Example responses

400 Response

{
  "code": "400",
  "message": "Validation exception",
  "errors": [
    {
      "scope": "global",
      "reason": "Invalid request",
      "message": "The value for the channel is invalid"
    }
  ]
}

Responses

Customers

Get Customers

Code samples

# You can also use wget
curl -X GET https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/customerexperience/contextCookies/customers \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'x-api-key: string'

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'x-api-key':'string'
};

fetch('https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/customerexperience/contextCookies/customers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/customerexperience/contextCookies/customers HTTP/1.1
Host: orgid.via.aspect-cloud.net
Accept: application/json
Authorization: string
x-api-key: string

GET /via/v2/organizations/{orgId}/customerexperience/contextCookies/customers

Returns all customers matching the filters

Parameters

Example responses

200 Response

{
  "kind": "cxp#contextCookiesCustomerCollection",
  "customers": [
    {
      "id": "customer1"
    }
  ],
  "totalItems": "1"
}

Responses

Services

Get Services

Code samples

# You can also use wget
curl -X GET https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/customerexperience/contextCookies/services \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'x-api-key: string'

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'x-api-key':'string'
};

fetch('https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/customerexperience/contextCookies/services',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/customerexperience/contextCookies/services HTTP/1.1
Host: orgid.via.aspect-cloud.net
Accept: application/json
Authorization: string
x-api-key: string

GET /via/v2/organizations/{orgId}/customerexperience/contextCookies/services

Returns all services

Parameters

Example responses

200 Response

{
  "kind": "cxp#contextCookiesServiceCollection",
  "services": [
    {
      "id": "service1"
    }
  ],
  "totalItems": "1"
}

Responses

Channels

Get Channels

Code samples

# You can also use wget
curl -X GET https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/customerexperience/contextCookies/channels \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'x-api-key: string'

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'x-api-key':'string'
};

fetch('https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/customerexperience/contextCookies/channels',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/customerexperience/contextCookies/channels HTTP/1.1
Host: orgid.via.aspect-cloud.net
Accept: application/json
Authorization: string
x-api-key: string

GET /via/v2/organizations/{orgId}/customerexperience/contextCookies/channels

Returns all channels

Parameters

Example responses

200 Response

{
  "kind": "cxp#contextCookiesChannelCollection",
  "channels": [
    {
      "id": "all"
    }
  ],
  "totalItems": "1"
}

Responses

Schemas

SettingCollection

{
  "kind": "cxp#contextCookiesSettingCollection",
  "settings": [
    {
      "customerId": "a",
      "key": "key1",
      "content": "content1",
      "channel": "all",
      "service": "a",
      "expiresOnTime": "2017-05-24T13:35:28.000Z",
      "creationTime": "2017-05-24T13:35:28.000Z",
      "lastModifiedTime": "2017-05-24T13:35:28.000Z"
    }
  ],
  "totalItems": "1"
}

Properties

SettingCollectionModify

{
  "settings": [
    {
      "customerId": "a",
      "key": "key1",
      "content": "content1",
      "channel": "voice",
      "service": "b",
      "expiresOnTime": "2017-05-24T13:35:28.000Z"
    }
  ]
}

Properties

CustomerCollection

{
  "kind": "cxp#contextCookiesCustomerCollection",
  "customers": [
    {
      "id": "customer1"
    }
  ],
  "totalItems": "1"
}

Properties

ServiceCollection

{
  "kind": "cxp#contextCookiesServiceCollection",
  "services": [
    {
      "id": "service1"
    }
  ],
  "totalItems": "1"
}

Properties

ChannelCollection

{
  "kind": "cxp#contextCookiesChannelCollection",
  "channels": [
    {
      "id": "all"
    }
  ],
  "totalItems": "1"
}

Properties

ErrorResponse

{
  "code": "400",
  "message": "Validation exception",
  "errors": [
    {
      "scope": "global",
      "reason": "Invalid request",
      "message": "The value for the channel is invalid"
    }
  ]
}

Properties

Error

{
  "scope": "global",
  "reason": "Invalid request",
  "message": "The value for the channel is invalid"
}

Properties