Api >

Service Portal REST API

GET returns requested Frontdesk Service's info
Test setup
Given there is a Frontdesk Service with:
  • extension 35
  • display name Frontdesk basic agent
  • serviceNumber 123
  • description frontdesk agent description
  • context frontdesk agent context
  • introduction text welcome frontdesk agent
  • voice de-DE-KatjaNeural
  • fallback target reference /api/customers/K0002/targets/conference-services/2
Given I am authenticated as customer K0002
When I send /api/customers/K0002/targets/frontdesk-services/123
Then I should receive HTTP/1.1 200 OK with following body:
{
  "href": "/api/customers/K0002/targets/frontdesk-services/123",
  "links": [{
    "rel": "fallbackTarget",
    "href": "/api/customers/K0002/targets/conference-services/2"
  }, {
    "rel": "inboundTrunkNumbers",
    "href": "/api/customers/K0002/targets/frontdesk-services/123/inbound-trunk-numbers"
  }],
  "data": [{
    "name": "name",
    "value": "Frontdesk basic agent"
  }, {
    "name": "displayName",
    "value": "Frontdesk basic agent"
  }, {
    "name": "extensionNumber",
    "value": "35"
  }, {
    "name": "type",
    "value": "FRONTDESK"
  }, {
    "name": "serviceNumber",
    "value": 123
  }, {
    "name": "serviceCode",
    "value": "*710123"
  }, {
    "name": "context",
    "value": "frontdesk agent context"
  }, {
    "name": "introText",
    "value": "welcome frontdesk agent"
  }, {
    "name": "voice",
    "value": "de-DE-KatjaNeural"
  }, {
    "name": "description",
    "value": "frontdesk agent description"
  }, {
    "name": "language",
    "value": "de"
  }]
}
GET returns 404 if requested Frontdesk Service does not exist
Test setup
Given there is a Frontdesk Service with:
  • extension 35
  • display name Frontdesk basic agent
  • serviceNumber 123
  • description frontdesk agent description
  • context frontdesk agent context
  • introduction text welcome frontdesk agent
  • voice de-DE-KatjaNeural
  • fallback target reference /api/customers/K0002/targets/conference-services/2
Given I am authenticated as customer K0002
and there is no Frontdesk Service with serviceNumber 404
When I send /api/customers/K0002/targets/frontdesk-services/404 Then I should receive HTTP/1.1 404 Not Found with following body:
{
  "detail": "Frontdesk Service with service number 404 not found",
  "title": "Frontdesk Service not found",
  "described_by": "http://api.nfon.net/probs/frontdesk-service-not-found"
}
Missing Customer
Test setup
Given there is a Frontdesk Service with:
  • extension 35
  • display name Frontdesk basic agent
  • serviceNumber 123
  • description frontdesk agent description
  • context frontdesk agent context
  • introduction text welcome frontdesk agent
  • voice de-DE-KatjaNeural
  • fallback target reference /api/customers/K0002/targets/conference-services/2
Given I am authenticated as Admin
When I send /api/customers/K404/targets/frontdesk-services/123
Then I should receive HTTP/1.1 404 Not Found
And Content-Type header should be application/api-problem+json
with following body:
{
  "detail": "Customer with identifier K404 has not been found",
  "title": "Customer not found",
  "described_by": "http://api.nfon.net/probs/customer-not-found"
}
GET returns 403 if Customer is trying to retrieve other Customer's Frontdesk Service
Test setup
Given there is a Frontdesk Service with:
  • extension 35
  • display name Frontdesk basic agent
  • serviceNumber 123
  • description frontdesk agent description
  • context frontdesk agent context
  • introduction text welcome frontdesk agent
  • voice de-DE-KatjaNeural
  • fallback target reference /api/customers/K0002/targets/conference-services/2
Given I am authenticated as K0003
and there is a Frontdesk Service with serviceNumber 123 When I send /api/customers/K0002/targets/frontdesk-services/123 Then I should receive HTTP/1.1 403 Forbidden with following body:
{
  "title": "Access forbidden",
  "detail": "Access denied to [Customer] with id [K0002]",
  "described_by": "http://api.nfon.net/probs/invalid-authorization"
}
System Integrator cannot access Frontdesk Service of Customer that does not belong to him
Test setup
Given there is a Frontdesk Service with:
  • extension 35
  • display name Frontdesk basic agent
  • serviceNumber 123
  • description frontdesk agent description
  • context frontdesk agent context
  • introduction text welcome frontdesk agent
  • voice de-DE-KatjaNeural
  • fallback target reference /api/customers/K0002/targets/conference-services/2
Given I am authenticated as System Integrator S0002
When I send /api/customers/K0003/targets/frontdesk-services/123
Then I should receive HTTP/1.1 403 Forbidden
with following body
{
  "title": "Access forbidden",
  "detail": "Access denied to [Customer] with id [K0003]",
  "described_by": "http://api.nfon.net/probs/invalid-authorization"
}
Operator cannot access Frontdesk Service of Customer that does not belong to him
Test setup
Given there is a Frontdesk Service with:
  • extension 35
  • display name Frontdesk basic agent
  • serviceNumber 123
  • description frontdesk agent description
  • context frontdesk agent context
  • introduction text welcome frontdesk agent
  • voice de-DE-KatjaNeural
  • fallback target reference /api/customers/K0002/targets/conference-services/2
Given I am authenticated as Operator C0002
When I send /api/customers/K0003/targets/frontdesk-services/123
Then I should receive HTTP/1.1 403 Forbidden
with following body
{
  "title": "Access forbidden",
  "detail": "Access denied to [Customer] with id [K0003]",
  "described_by": "http://api.nfon.net/probs/invalid-authorization"
}