Alvaria Public Cloud Messaging (Chat/SMS) REST API v2.0.1

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 Public Cloud™ Messaging (Chat/SMS) REST APIs enable a custom agent application to send text and URLs using a current chat or SMS interaction. Please note that the group of scopes most likely needed when you create a custom agent interface are engagementcenterapi, provisioningapi, messagingapi, outreachapi and streamingapi.

Follow this link if you would like to see the events generated by sending these requests.

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

Users

User Send Text

Code samples

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

const fetch = require('node-fetch');
const inputBody = {
  "interactionId": "4321",
  "entityName": "contactCenterAgent",
  "entityType": "Agent",
  "text": "Hi this is an example of a text string."
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'string',
  'x-api-key':'string',
  'via-client-sessionid':'string'
};

fetch('https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/messaging/users/{userId}/sendText',
{
  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}/messaging/users/{userId}/sendText HTTP/1.1
Host: orgid.via.aspect-cloud.net
Content-Type: application/json
Accept: application/json
Authorization: string
x-api-key: string
via-client-sessionid: string

POST /via/v2/organizations/{orgId}/messaging/users/{userId}/sendText

This sends a request to the Messaging subsystem containing text on an interaction.

Body parameter

{
  "interactionId": "4321",
  "entityName": "contactCenterAgent",
  "entityType": "Agent",
  "text": "Hi this is an example of a text string."
}

Parameters

Example responses

400 Response

{
  "code": 404,
  "message": "not found",
  "errors": [
    {
      "scope": "scope",
      "reason": "reason",
      "message": "message"
    }
  ]
}

Responses

User Send Notification state

Code samples

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

const fetch = require('node-fetch');
const inputBody = {
  "interactionId": "4321",
  "entityName": "contactCenterAgent",
  "entityType": "Agent",
  "state": "composing",
  "expiresAfterSeconds": 10
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'string',
  'x-api-key':'string',
  'via-client-sessionid':'string'
};

fetch('https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/messaging/users/{userId}/notification',
{
  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}/messaging/users/{userId}/notification HTTP/1.1
Host: orgid.via.aspect-cloud.net
Content-Type: application/json
Accept: application/json
Authorization: string
x-api-key: string
via-client-sessionid: string

POST /via/v2/organizations/{orgId}/messaging/users/{userId}/notification

To allow for slight message delays in transit, the next composing notification should be sent before the expiresAfterSeconds timeframe. For example, if the expiresAfterSeconds field is set to ten seconds, it is recommended to send the composing state at least once every nine seconds while the user is actively typing. The receiving entity will reset its typing indicator expiration after each composing notification. After the typing indicator expiration (ten seconds in this example) of not receiving the composing notification, the receiving party's UI will hide the typing indicator.

Body parameter

{
  "interactionId": "4321",
  "entityName": "contactCenterAgent",
  "entityType": "Agent",
  "state": "composing",
  "expiresAfterSeconds": 10
}

Parameters

Example responses

400 Response

{
  "code": 404,
  "message": "not found",
  "errors": [
    {
      "scope": "scope",
      "reason": "reason",
      "message": "message"
    }
  ]
}

Responses

User Push Url

Code samples

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

const fetch = require('node-fetch');
const inputBody = {
  "interactionId": "4321",
  "entityName": "contactCenterAgent",
  "entityType": "Agent",
  "url": "https://www.alvaria.com"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'string',
  'x-api-key':'string',
  'via-client-sessionid':'string'
};

fetch('https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/messaging/users/{userId}/sendUrl',
{
  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}/messaging/users/{userId}/sendUrl HTTP/1.1
Host: orgid.via.aspect-cloud.net
Content-Type: application/json
Accept: application/json
Authorization: string
x-api-key: string
via-client-sessionid: string

POST /via/v2/organizations/{orgId}/messaging/users/{userId}/sendUrl

This sends a request to the Messaging subsystem containing a URL for an interaction.

Body parameter

{
  "interactionId": "4321",
  "entityName": "contactCenterAgent",
  "entityType": "Agent",
  "url": "https://www.alvaria.com"
}

Parameters

Example responses

400 Response

{
  "code": 404,
  "message": "not found",
  "errors": [
    {
      "scope": "scope",
      "reason": "reason",
      "message": "message"
    }
  ]
}

Responses

Schemas

SendTextParmsSchema

{
  "interactionId": "4321",
  "entityName": "contactCenterAgent",
  "entityType": "Agent",
  "text": "Hi this is an example of a text string."
}

Properties

Enumerated Values

NotificationParmsSchema

{
  "interactionId": "4321",
  "entityName": "contactCenterAgent",
  "entityType": "Agent",
  "state": "composing",
  "expiresAfterSeconds": 10
}

Properties

Enumerated Values

SendUrlParmsSchema

{
  "interactionId": "4321",
  "entityName": "contactCenterAgent",
  "entityType": "Agent",
  "url": "https://www.alvaria.com"
}

Properties

Enumerated Values

ErrorResponse

{
  "code": 404,
  "message": "not found",
  "errors": [
    {
      "scope": "scope",
      "reason": "reason",
      "message": "message"
    }
  ]
}

Properties

Error

{
  "scope": "scope",
  "reason": "reason",
  "message": "message"
}

Properties