Api >

Service Portal REST API

GET /api/customers/{customer-id}/targets/queue-services

GET a list of Queue Services
Given I am authenticated as customer K0002
And there is a queue service
  • with name queue name
  • with service number 345
  • and asterisk extension number 576
And there is another queue service
  • with name another queue name
  • with service number 987
  • and asterisk extension number 123
And there is a skill service
  • with name skill name
  • with service number 999
  • and asterisk extension number 888
When I send /api/customers/K0002/targets/queue-services
Then I should receive HTTP/1.1 200 OK
with following body: 
{
  "href": "/api/customers/K0002/targets/queue-services?_offset=0&_pagesize=16&_orderBy=serviceNumber&_order=ASC",
  "offset": 0,
  "total": 2,
  "size": 2,
  "links": [{
    "rel": "availableDestinationsOnRejection",
    "href": "/api/customers/K0002/targets/queue-services/available-destinations-on-rejection"
  }, {
    "rel": "availableDestinationsOnTimeout",
    "href": "/api/customers/K0002/targets/queue-services/available-destinations-on-timeout"
  }, {
    "rel": "availableGeneralAnnouncements",
    "href": "/api/customers/K0002/targets/queue-services/available-general-announcements"
  }, {
    "rel": "availableMusicOnHoldAnnouncements",
    "href": "/api/customers/K0002/targets/queue-services/available-music-on-hold-announcements"
  }],
  "items": [{
    "href": "/api/customers/K0002/targets/queue-services/345",
    "links": [],
    "data": [{
      "name": "name",
      "value": "queue name"
    }, {
      "name": "displayName",
      "value": "queue name"
    }, {
      "name": "extensionNumber",
      "value": "576"
    }, {
      "name": "type",
      "value": "QUEUE"
    }, {
      "name": "serviceNumber",
      "value": 345
    }, {
      "name": "serviceCode",
      "value": "*770345"
    }]
  }, {
    "href": "/api/customers/K0002/targets/queue-services/987",
    "links": [],
    "data": [{
      "name": "name",
      "value": "another queue name"
    }, {
      "name": "displayName",
      "value": "another queue name"
    }, {
      "name": "extensionNumber",
      "value": "123"
    }, {
      "name": "type",
      "value": "QUEUE"
    }, {
      "name": "serviceNumber",
      "value": 987
    }, {
      "name": "serviceCode",
      "value": "*770987"
    }]
  }]
}
GET a list of Queue Services ordered by extensionNumber ascending
Given I am authenticated as customer K0002
And there is a queue service
  • with name queue name
  • with service number 345
  • and asterisk extension number 576
And there is another queue service
  • with name another queue name
  • with service number 987
  • and asterisk extension number 123
And there is a skill service
  • with name skill name
  • with service number 999
  • and asterisk extension number 888
When I send /api/customers/K0002/targets/queue-services?_orderBy=extensionNumber&_order=asc
Then I should receive HTTP/1.1 200 OK
with following body: 
{
  "href": "/api/customers/K0002/targets/queue-services?_offset=0&_pagesize=16&_orderBy=extensionNumber&_order=ASC",
  "offset": 0,
  "total": 2,
  "size": 2,
  "links": [{
    "rel": "availableDestinationsOnRejection",
    "href": "/api/customers/K0002/targets/queue-services/available-destinations-on-rejection"
  }, {
    "rel": "availableDestinationsOnTimeout",
    "href": "/api/customers/K0002/targets/queue-services/available-destinations-on-timeout"
  }, {
    "rel": "availableGeneralAnnouncements",
    "href": "/api/customers/K0002/targets/queue-services/available-general-announcements"
  }, {
    "rel": "availableMusicOnHoldAnnouncements",
    "href": "/api/customers/K0002/targets/queue-services/available-music-on-hold-announcements"
  }],
  "items": [{
    "href": "/api/customers/K0002/targets/queue-services/987",
    "links": [],
    "data": [{
      "name": "name",
      "value": "another queue name"
    }, {
      "name": "displayName",
      "value": "another queue name"
    }, {
      "name": "extensionNumber",
      "value": "123"
    }, {
      "name": "type",
      "value": "QUEUE"
    }, {
      "name": "serviceNumber",
      "value": 987
    }, {
      "name": "serviceCode",
      "value": "*770987"
    }]
  }, {
    "href": "/api/customers/K0002/targets/queue-services/345",
    "links": [],
    "data": [{
      "name": "name",
      "value": "queue name"
    }, {
      "name": "displayName",
      "value": "queue name"
    }, {
      "name": "extensionNumber",
      "value": "576"
    }, {
      "name": "type",
      "value": "QUEUE"
    }, {
      "name": "serviceNumber",
      "value": 345
    }, {
      "name": "serviceCode",
      "value": "*770345"
    }]
  }]
}
GET a list of Queue Services ordered by extensionNumber descending
Given I am authenticated as customer K0002
And there is a queue service
  • with name queue name
  • with service number 345
  • and asterisk extension number 576
And there is another queue service
  • with name another queue name
  • with service number 987
  • and asterisk extension number 123
And there is a skill service
  • with name skill name
  • with service number 999
  • and asterisk extension number 888
When I send /api/customers/K0002/targets/queue-services?_orderBy=extensionNumber&_order=desc
Then I should receive HTTP/1.1 200 OK
with following body: 
{
  "href": "/api/customers/K0002/targets/queue-services?_offset=0&_pagesize=16&_orderBy=extensionNumber&_order=DESC",
  "offset": 0,
  "total": 2,
  "size": 2,
  "links": [{
    "rel": "availableDestinationsOnRejection",
    "href": "/api/customers/K0002/targets/queue-services/available-destinations-on-rejection"
  }, {
    "rel": "availableDestinationsOnTimeout",
    "href": "/api/customers/K0002/targets/queue-services/available-destinations-on-timeout"
  }, {
    "rel": "availableGeneralAnnouncements",
    "href": "/api/customers/K0002/targets/queue-services/available-general-announcements"
  }, {
    "rel": "availableMusicOnHoldAnnouncements",
    "href": "/api/customers/K0002/targets/queue-services/available-music-on-hold-announcements"
  }],
  "items": [{
    "href": "/api/customers/K0002/targets/queue-services/345",
    "links": [],
    "data": [{
      "name": "name",
      "value": "queue name"
    }, {
      "name": "displayName",
      "value": "queue name"
    }, {
      "name": "extensionNumber",
      "value": "576"
    }, {
      "name": "type",
      "value": "QUEUE"
    }, {
      "name": "serviceNumber",
      "value": 345
    }, {
      "name": "serviceCode",
      "value": "*770345"
    }]
  }, {
    "href": "/api/customers/K0002/targets/queue-services/987",
    "links": [],
    "data": [{
      "name": "name",
      "value": "another queue name"
    }, {
      "name": "displayName",
      "value": "another queue name"
    }, {
      "name": "extensionNumber",
      "value": "123"
    }, {
      "name": "type",
      "value": "QUEUE"
    }, {
      "name": "serviceNumber",
      "value": 987
    }, {
      "name": "serviceCode",
      "value": "*770987"
    }]
  }]
}
GET a list of Queue Services ordered by name ascending
Given I am authenticated as customer K0002
And there is a queue service
  • with name queue name
  • with service number 345
  • and asterisk extension number 576
And there is another queue service
  • with name another queue name
  • with service number 987
  • and asterisk extension number 123
And there is a skill service
  • with name skill name
  • with service number 999
  • and asterisk extension number 888
When I send /api/customers/K0002/targets/queue-services?_orderBy=name&_order=asc
Then I should receive HTTP/1.1 200 OK
with following body: 
{
  "href": "/api/customers/K0002/targets/queue-services?_offset=0&_pagesize=16&_orderBy=name&_order=ASC",
  "offset": 0,
  "total": 2,
  "size": 2,
  "links": [{
    "rel": "availableDestinationsOnRejection",
    "href": "/api/customers/K0002/targets/queue-services/available-destinations-on-rejection"
  }, {
    "rel": "availableDestinationsOnTimeout",
    "href": "/api/customers/K0002/targets/queue-services/available-destinations-on-timeout"
  }, {
    "rel": "availableGeneralAnnouncements",
    "href": "/api/customers/K0002/targets/queue-services/available-general-announcements"
  }, {
    "rel": "availableMusicOnHoldAnnouncements",
    "href": "/api/customers/K0002/targets/queue-services/available-music-on-hold-announcements"
  }],
  "items": [{
    "href": "/api/customers/K0002/targets/queue-services/987",
    "links": [],
    "data": [{
      "name": "name",
      "value": "another queue name"
    }, {
      "name": "displayName",
      "value": "another queue name"
    }, {
      "name": "extensionNumber",
      "value": "123"
    }, {
      "name": "type",
      "value": "QUEUE"
    }, {
      "name": "serviceNumber",
      "value": 987
    }, {
      "name": "serviceCode",
      "value": "*770987"
    }]
  }, {
    "href": "/api/customers/K0002/targets/queue-services/345",
    "links": [],
    "data": [{
      "name": "name",
      "value": "queue name"
    }, {
      "name": "displayName",
      "value": "queue name"
    }, {
      "name": "extensionNumber",
      "value": "576"
    }, {
      "name": "type",
      "value": "QUEUE"
    }, {
      "name": "serviceNumber",
      "value": 345
    }, {
      "name": "serviceCode",
      "value": "*770345"
    }]
  }]
}
GET a list of Queue Services ordered by name descending
Given I am authenticated as customer K0002
And there is a queue service
  • with name queue name
  • with service number 345
  • and asterisk extension number 576
And there is another queue service
  • with name another queue name
  • with service number 987
  • and asterisk extension number 123
And there is a skill service
  • with name skill name
  • with service number 999
  • and asterisk extension number 888
When I send /api/customers/K0002/targets/queue-services?_orderBy=name&_order=desc
Then I should receive HTTP/1.1 200 OK
with following body: 
{
  "href": "/api/customers/K0002/targets/queue-services?_offset=0&_pagesize=16&_orderBy=name&_order=DESC",
  "offset": 0,
  "total": 2,
  "size": 2,
  "links": [{
    "rel": "availableDestinationsOnRejection",
    "href": "/api/customers/K0002/targets/queue-services/available-destinations-on-rejection"
  }, {
    "rel": "availableDestinationsOnTimeout",
    "href": "/api/customers/K0002/targets/queue-services/available-destinations-on-timeout"
  }, {
    "rel": "availableGeneralAnnouncements",
    "href": "/api/customers/K0002/targets/queue-services/available-general-announcements"
  }, {
    "rel": "availableMusicOnHoldAnnouncements",
    "href": "/api/customers/K0002/targets/queue-services/available-music-on-hold-announcements"
  }],
  "items": [{
    "href": "/api/customers/K0002/targets/queue-services/345",
    "links": [],
    "data": [{
      "name": "name",
      "value": "queue name"
    }, {
      "name": "displayName",
      "value": "queue name"
    }, {
      "name": "extensionNumber",
      "value": "576"
    }, {
      "name": "type",
      "value": "QUEUE"
    }, {
      "name": "serviceNumber",
      "value": 345
    }, {
      "name": "serviceCode",
      "value": "*770345"
    }]
  }, {
    "href": "/api/customers/K0002/targets/queue-services/987",
    "links": [],
    "data": [{
      "name": "name",
      "value": "another queue name"
    }, {
      "name": "displayName",
      "value": "another queue name"
    }, {
      "name": "extensionNumber",
      "value": "123"
    }, {
      "name": "type",
      "value": "QUEUE"
    }, {
      "name": "serviceNumber",
      "value": 987
    }, {
      "name": "serviceCode",
      "value": "*770987"
    }]
  }]
}
GET retrieves filtered Customer's Queues
Filtering is done on fields :
  • name
  • serviceNumber
  • extensionNumber
Given I am authenticated as customer K0002
And there is a queue service
  • with name queue name
  • with service number 18
  • and asterisk extension number 576
And there is another queue service
  • with name another queue name
  • with service number 987
  • and asterisk extension number 123
When I send /api/customers/K0002/targets/queue-services?_q=18
Then I should receive HTTP/1.1 200 OK
with following body: 
{
  "href": "/api/customers/K0002/targets/queue-services?_offset=0&_pagesize=16&_q=18&_orderBy=serviceNumber&_order=ASC",
  "offset": 0,
  "total": 1,
  "size": 1,
  "links": [{
    "rel": "availableDestinationsOnRejection",
    "href": "/api/customers/K0002/targets/queue-services/available-destinations-on-rejection"
  }, {
    "rel": "availableDestinationsOnTimeout",
    "href": "/api/customers/K0002/targets/queue-services/available-destinations-on-timeout"
  }, {
    "rel": "availableGeneralAnnouncements",
    "href": "/api/customers/K0002/targets/queue-services/available-general-announcements"
  }, {
    "rel": "availableMusicOnHoldAnnouncements",
    "href": "/api/customers/K0002/targets/queue-services/available-music-on-hold-announcements"
  }],
  "items": [{
    "href": "/api/customers/K0002/targets/queue-services/18",
    "links": [],
    "data": [{
      "name": "name",
      "value": "queue name"
    }, {
      "name": "displayName",
      "value": "queue name"
    }, {
      "name": "extensionNumber",
      "value": "576"
    }, {
      "name": "type",
      "value": "QUEUE"
    }, {
      "name": "serviceNumber",
      "value": 18
    }, {
      "name": "serviceCode",
      "value": "*770018"
    }]
  }]
}
GET does not returns extensionNumber that starts with asterisk '*' a list of Queue Services
Given I am authenticated as customer K0002
And there is a queue service
  • with name queue name
  • with service number 345
  • and asterisk extension number *576
When I send /api/customers/K0002/targets/queue-services
Then I should receive HTTP/1.1 200 OK
with following body: 
{
  "href": "/api/customers/K0002/targets/queue-services?_offset=0&_pagesize=16&_orderBy=serviceNumber&_order=ASC",
  "offset": 0,
  "total": 1,
  "size": 1,
  "links": [{
    "rel": "availableDestinationsOnRejection",
    "href": "/api/customers/K0002/targets/queue-services/available-destinations-on-rejection"
  }, {
    "rel": "availableDestinationsOnTimeout",
    "href": "/api/customers/K0002/targets/queue-services/available-destinations-on-timeout"
  }, {
    "rel": "availableGeneralAnnouncements",
    "href": "/api/customers/K0002/targets/queue-services/available-general-announcements"
  }, {
    "rel": "availableMusicOnHoldAnnouncements",
    "href": "/api/customers/K0002/targets/queue-services/available-music-on-hold-announcements"
  }],
  "items": [{
    "href": "/api/customers/K0002/targets/queue-services/345",
    "links": [],
    "data": [{
      "name": "name",
      "value": "queue name"
    }, {
      "name": "displayName",
      "value": "queue name"
    }, {
      "name": "type",
      "value": "QUEUE"
    }, {
      "name": "serviceNumber",
      "value": 345
    }, {
      "name": "serviceCode",
      "value": "*770345"
    }]
  }]
}
Missing Customer
Given I am authenticated as Admin
When I send /api/customers/K404/targets/queue-services
Then I should receive HTTP/1.1 404 Not Found 
{
  "title": "Customer not found",
  "detail": "Customer with identifier K404 has not been found",
  "described_by": "http://api.nfon.net/probs/customer-not-found"
}
Customer should not be able to GET another Customer's Queues
Given I am authenticated as Customer K0003
When I send /api/customers/K0002/targets/queue-services
Then I should receive HTTP/1.1 403 Forbidden 
{
  "title": "Access forbidden",
  "detail": "Access denied to [Customer] with id [K0002]",
  "described_by": "http://api.nfon.net/probs/invalid-authorization"
}
System Integrator should not be able to GET data of a Customer that he cannot manage
Given I am authenticated as System Integrator S0002
When I send /api/customers/K0003/targets/queue-services
Then I should receive HTTP/1.1 403 Forbidden 
{
  "title": "Access forbidden",
  "detail": "Access denied to [Customer] with id [K0003]",
  "described_by": "http://api.nfon.net/probs/invalid-authorization"
}
Operator should not be able to GET data of a Customer that he cannot manage
Given I am authenticated as Operator C0002
When I send /api/customers/K0003/targets/queue-services
Then I should receive HTTP/1.1 403 Forbidden 
{
  "title": "Access forbidden",
  "detail": "Access denied to [Customer] with id [K0003]",
  "described_by": "http://api.nfon.net/probs/invalid-authorization"
}
Results generated by Concordion
in 1250 ms on 25-Feb-2026 at 00:45:08 CET