GET /services/:csi

Description

Retrieves the specified service based on its CSI (Common Service Identifier).

URL

https://api.keyyo.com/manager/1.0/services/:csi

Parameters

:csi

The Common Service Identifier of the service to retrieve

Result

A Keyyo service

UCaaSVoIPAccount A centrex --more formally known as "Unified Communications as a Service"-- SIP VoIP account
NumberTranslation A number translation account
EmailAccount An email account
DSLAccess DSL access base class
FaxTransfer A fax transfer
ACDService A call group service
MobileAccount A mobile phone account
VirtualFaxAccount A virtual fax account

Relationships

GET /services/:csi/profiles Retrieves the profile list available for the specified service.
GET /services/:csi/cti_plugins Retrieves the list of CTI plugins available on this account.
GET /services/:csi/available_upgrades Retrieves the list of available upgrades (new offers) for this service.
POST /services/:csi/upgrade Upgrades the service to the specified target offer.
GET /services/:csi/provisioning_tasks Retrieves a list of provisioning tasks requested on this service.
POST /services/:csi/reset_password Reset the CSI (Common Service Identifier) password.
GET /services/:csi/call_barring_groups Retrieve the list of call barring groups available for a specific CSI (Common Service Identifier).
GET /services/:csi/call_barred_groups Retrieve the call barred group list of a specific CSI (Common Service Identifier).
PUT /services/:csi/call_barred_groups Update the call barred group list of a specific CSI (Common Service Identifier).
GET /services/:csi/incoming_call_detail Retrieves a list of incoming call detail records to this telephony service.
(Parameters must be passed using a parameter-value array.)
GET /services/:csi/outgoing_call_detail Retrieves a list of outgoing call detail records from this telephony service.
(Parameters must be passed using a parameter-value array.)
GET /services/:csi/blacklist Retrieves the blacklist of a specific service, i.e. the list of phone numbers that are not allowed to call this CSI.
(If anonymous calls are included, "anonymous" will be listed in the results.)
GET /services/:csi/sip_records Retrieves the list of SIP recordings for the given service.

Samples


$ curl --header "Authorization: Bearer YOUR_ACCESS_TOKEN" https://api.keyyo.com/manager/1.0/services/33175456987
{
    "_links": {
        "self": {
            "href": "https://api.keyyo.com/manager/1.0/services/33175430359"
        },
        "available_upgrades": {
            "href": "https://api.keyyo.com/manager/1.0/services/33175430359/available_upgrades"
        },
        "provisioning_tasks": {
            "href": "https://api.keyyo.com/manager/1.0/services/33175430359/provisioning_tasks"
        }
    },
    "_resource_type": "ACDService",
    "csi": "33175430359",
    "formatted_csi": "+33175430359",
    "name": "Accueil 1",
    "offer_id": 21,
    "offer_name": "Groupe d'appel",
    "commitment_start_date": null,
    "status": "in_service",
    "blocking_status": null,
    "options": []
}

<?php
require_once('lib/Keyyo/autoload.php');

$access_token 'YOUR_ACCESS_TOKEN';

$client = new \Keyyo\Manager\Client('1.0'$access_token);
$services $client->services(33175456987);

echo 
$service->status;

curl --header "Authorization: Bearer YOUR_ACCESS_TOKEN" -H "Accept: application/xml" https://api.keyyo.com/manager/1.0/services/33175456987
<?xml version="1.0"?>
<resource href="https://api.keyyo.com/manager/1.0/services/33175430359">
  <link href="https://api.keyyo.com/manager/1.0/services/33175430359/available_upgrades" rel="available_upgrades"/>
  <link href="https://api.keyyo.com/manager/1.0/services/33175430359/provisioning_tasks" rel="provisioning_tasks"/>
  <_resource_type>ACDService</_resource_type>
  <csi>33175430359</csi>
  <formatted_csi>+33175430359</formatted_csi>
  <name>Accueil 1</name>
  <offer_id>21</offer_id>
  <offer_name>Groupe d'appel</offer_name>
  <commitment_start_date/>
  <status>in_service</status>
  <blocking_status/>
  <options/>
</resource>