POST /api/spacescalling/{callType}/call

Initiates an 'aura' type call. To successfully make this type of call, a caller must:

  • have the required license
  • be from a whitelisted billing country
  • be opted-in as per spaces records

Header

NameDescriptionData TypeRequired
AuthorizationJwt/OAuth2 bearer tokenStringYes

URL Parameters

NameDescriptionLocationRequired
callTypeType of the call, in this case, "aura"pathYes

Body Parameters

NameDescriptionJSON typeRequiredDefault Value
calleesArray describing callees to call.
  • displayname: (string) an empty string.
  • address: (string) phone number assigned to said user.
Array of objectsYes

Authentication

JwtAuthenticator, Oauth2Authenticator

Example Request

URL

For Production: POST https://spacesapis.avayacloud.com/api/spacescalling/{callType}/call 
For Staging: POST https://loganstagingapis.esna.com/api/spacescalling/{callType}/call

Headers

Authorization: "jwt eyJhbGciOiJSUzl1NiIsIdfgdfgnR5cCI6IkpXVCJ9.eyJ1c2VyX3lkX3NpZyI6ImxPWHpxNzVzR3J3X0xwWEMyRGRMakhyYXJlWVhyTzFMdEZHZkhkOWNkTXciLCJwcm9kdWN0X3R5cGUiOiJhY2NvdW50cyIsImxhc3R1cGRhdGV0aW1lIjoiMjAxNy0wMS0zMFQxMzo1ODo0Ny4yMDYiLCJpc3MiOiJ6YW5nLmlvIiwicHVibGlja2V5aWQiOiJhZ3h6Zm05dVpYTnVZVEl3TVRSeUdnc1NEVWRLZDNSUWRXSnNhV05MWlhrdfgdWdJQ2dsUEtFakFvTSIsImV4cCI6MTQ5NTM5MTIwMywidXNlcl9pZCI6ImFneHpmbTl1WlhOdVlUSXdNVFJ5RVFzU0JGVnpaWElZZ0lEQXMtX25fUW9NIiwidmVyIjoiMi4wIn0.SqZpw1uPIebqW3qlDsm0-DWYFKEH0SgPwtD-tSESWOF-5hLkZMqJH28ooWux2S7s9riIew7pTVPnZpTgJa5zHcEAG0gXSEJVOqmpGp_4ufM8YtZoZMpBFjyAkwyAt-ILkGUYIo0GU5WyzMPLV8YLXfgdfgOgkE2MGGOajBkjPmC2Db3pA0D0M9k-21EL1gwWBC5YIq0PDAkgulegwl6khRmB8irJQ-dfg-d-KV9eYfFpsCdJKRGzSfqg"

Or

Authorization: "bearer f746696f5de4528u128ae2f274eea253e8a7943a"

Body

{"callees":[{"address":"{Callee phone number}","displayname":""}]}

Example code snippet (Aura call):

curl --location --request POST 'https://spacesapis.avayacloud.com/api/spacescalling/Aura/call' --header 'authorization: jwt ey...' --header 'content-type: application/json' --data-raw '{"callees":[{"address":"+xxxxxxxxxxx","displayname":""}]}'
const request = require('request');
const options = {
  'method': 'POST',
  'url': 'https://spacesapis.avayacloud.com/api/spacescalling/aura/call',
  'headers': {
    'authorization': 'jwt ey...',
    'content-type': 'application/json'
  },
  body: JSON.stringify({
    "callees": [
      {
        "address": "+xxxxxxxxxxx",
        "displayname": ""
      }
    ]
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Example Response

{
    "category": "space.call.offer.sent",
    "content": {
        "mediaSession": {
            "id": "51516ef64c16309108df7e7df71ea065487d25f3",
            "token": "eyJzZXNzaW9uSWQiOiI1MTUxNmVmNjRjMTYzMDkxMDhkZjdlN2RmNzFlYTA2NTQ4N2QyNWYzIiwic2Vzc2lvblRva2VuIjoiZXlKcmFXUWlPaUp0Y0dGaGN5MXpaWE56YVc5dUxXbGtJaXdpWVd4bklqb2lTRk16T0RRaWZRLmV5SnpkV0lpT2lJMU1UVXhObVZtTmpSak1UWXpNRGt4TURoa1pqZGxOMlJtTnpGbFlUQTJOVFE0TjJReU5XWXpJaXdpY205c1pYTWlPaUp6WlhOemFXOXVJaXdpYVdGMElqb3hOalV4TVRNeE5qazJMQ0psZUhBaU9qRTJOVEV5TVRnd09UWjkuM1lETENkNFZDZHFUdFB5SVRDbW1JQkRwcnpqRGpSRG9xRmQtUXNTR2tRdldndWF4OUIxa1VKV3dUYmh4LU0tbSIsInVzZXJBZ2VudFVSTCI6Imh0dHBzOi8vbXBhYXMuYXZheWFjbG91ZC5jb20vY3NhL3Jlc291cmNlcy90ZW5hbnRzL2RlZmF1bHQifQ=="
        }
    },
    "conversationId": "9390eca2-d5b0-4087-a20d-418889c75dd3",
    "created": "2022-04-28T07:41:36.717Z",
    "receivers": [
        {
            "_id": "626a452e4f227268fee45731",
            "address": "{callee number}",
            "callingDetails": {
                "callStatus": "calling",
                "isCaller": false
            },
            "displayname": "{callee number}",
            "picture_url": "https://accounts.zang.io/norevimages/noimage.jpg",
            "type": "aura",
            "username": "{callee number}"
        }
    ],
    "sender": {
        "_id": "{Caller UserId}",
        "address": "{Caller phone number in Spaces}",
        "aType": "user",
        "callingDetails": {
            "callStatus": "calling",
            "isCaller": true
        },
        "displayname": "{Caller name}",
        "endpointId": "{Caller UserId}",
        "ndbid": "agxzfm9uZXNuYTIlMTRyEQsSBFVzZXIYgIDQuZ_s1QsM",
        "picture_url": "https://accounts.zang.io/norevimages/noimage.jpg",
        "type": "user",
        "username": "test_user@avaya.com"
    },
    "spaceCallId": "626a452f4f2272dd1de45736",
    "topicId": "61e5ae480a33b379d699ea81",
    "topicTitle": ""
}