GET /services
Description
Retrieves a list of subscribed services, optionally filtered.
URL
https://api.keyyo.com/manager/1.0/servicesParameters
| type |
If present, filters the type(s) of services to retrieve |
Result
A list of services which can be of the following types:
| 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 | Retrieves the specified service based on its CSI (Common Service Identifier). |
Samples
$ curl --header "Authorization: Bearer YOUR_ACCESS_TOKEN" https://api.keyyo.com/manager/1.0/services
{
"_links": {
"self": {
"href": "https://api.keyyo.com/manager/1.0/services"
}
},
"_embedded": {
"ACDService": [
{
"_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": {}
},
{
"_links": {
"self": {
"href": "https://api.keyyo.com/manager/1.0/services/33988994158"
},
"available_upgrades": {
"href": "https://api.keyyo.com/manager/1.0/services/33988994158/available_upgrades"
},
"provisioning_tasks": {
"href": "https://api.keyyo.com/manager/1.0/services/33988994158/provisioning_tasks"
}
},
"_resource_type": "ACDService",
"csi": "33988994158",
"formatted_csi": "+33988994158",
"name": "Accueil 2",
"offer_id": 21,
"offer_name": "Groupe d'appel",
"commitment_start_date": null,
"status": "setup_pending",
"blocking_status": null,
"options": {}
},
{
"_links": {
"self": {
"href": "https://api.keyyo.com/manager/1.0/services/33974771733"
},
"available_upgrades": {
"href": "https://api.keyyo.com/manager/1.0/services/33974771733/available_upgrades"
},
"provisioning_tasks": {
"href": "https://api.keyyo.com/manager/1.0/services/33974771733/provisioning_tasks"
}
},
"_resource_type": "ACDService",
"csi": "33974771733",
"formatted_csi": "+33974771733",
"name": "Accueil 4",
"offer_id": 21,
"offer_name": "Groupe d'appel",
"commitment_start_date": null,
"status": "setup_pending",
"blocking_status": null,
"options": {}
},
{
"_links": {
"self": {
"href": "https://api.keyyo.com/manager/1.0/services/33362275290"
},
"available_upgrades": {
"href": "https://api.keyyo.com/manager/1.0/services/33362275290/available_upgrades"
},
"provisioning_tasks": {
"href": "https://api.keyyo.com/manager/1.0/services/33362275290/provisioning_tasks"
}
},
"_resource_type": "ACDService",
"csi": "33362275290",
"formatted_csi": "+33362275290",
"name": "Numéro d'accueil",
"offer_id": 21,
"offer_name": "Groupe d'appel",
"commitment_start_date": null,
"status": "setup_pending",
"blocking_status": null,
"options": {}
},
{
"_links": {
"self": {
"href": "https://api.keyyo.com/manager/1.0/services/33481915570"
},
"available_upgrades": {
"href": "https://api.keyyo.com/manager/1.0/services/33481915570/available_upgrades"
},
"provisioning_tasks": {
"href": "https://api.keyyo.com/manager/1.0/services/33481915570/provisioning_tasks"
}
},
"_resource_type": "ACDService",
"csi": "33481915570",
"formatted_csi": "+33481915570",
"name": "Numéro d'accueil",
"offer_id": 21,
"offer_name": "Groupe d'appel",
"commitment_start_date": null,
"status": "in_service",
"blocking_status": null,
"options": {}
}
],
"NumberTranslation": [
{
"_links": {
"self": {
"href": "https://api.keyyo.com/manager/1.0/services/33811030854"
},
"available_upgrades": {
"href": "https://api.keyyo.com/manager/1.0/services/33811030854/available_upgrades"
},
"provisioning_tasks": {
"href": "https://api.keyyo.com/manager/1.0/services/33811030854/provisioning_tasks"
}
},
"_resource_type": "NumberTranslation",
"csi": "33811030854",
"formatted_csi": "+33811030854",
"name": "Accueil 1 en 08",
"offer_id": 247,
"offer_name": "8016 - Numéro Spécial online",
"commitment_start_date": null,
"status": "suspended",
"blocking_status": "blocked",
"options": {}
},
{
"_links": {
"self": {
"href": "https://api.keyyo.com/manager/1.0/services/33811030874"
},
"available_upgrades": {
"href": "https://api.keyyo.com/manager/1.0/services/33811030874/available_upgrades"
},
"provisioning_tasks": {
"href": "https://api.keyyo.com/manager/1.0/services/33811030874/provisioning_tasks"
}
},
"_resource_type": "NumberTranslation",
"csi": "33811030874",
"formatted_csi": "+33811030874",
"name": "Accueil 2 en 08",
"offer_id": 247,
"offer_name": "8016 - Numéro Spécial online",
"commitment_start_date": null,
"status": "suspended",
"blocking_status": "blocked",
"options": {}
},
{
"_links": {
"self": {
"href": "https://api.keyyo.com/manager/1.0/services/33811261598"
},
"available_upgrades": {
"href": "https://api.keyyo.com/manager/1.0/services/33811261598/available_upgrades"
},
"provisioning_tasks": {
"href": "https://api.keyyo.com/manager/1.0/services/33811261598/provisioning_tasks"
}
},
"_resource_type": "NumberTranslation",
"csi": "33811261598",
"formatted_csi": "+33811261598",
"name": "Test créa MC 1",
"offer_id": 247,
"offer_name": "8016 - Numéro Spécial online",
"commitment_start_date": null,
"status": "suspended",
"blocking_status": "blocked",
"options": {}
}
],
"UCaaSVoIPAccount": [
{
"_links": {
"self": {
"href": "https://api.keyyo.com/manager/1.0/services/33175434051"
},
"available_upgrades": {
"href": "https://api.keyyo.com/manager/1.0/services/33175434051/available_upgrades"
},
"provisioning_tasks": {
"href": "https://api.keyyo.com/manager/1.0/services/33175434051/provisioning_tasks"
},
"cti_plugins": {
"href": "https://api.keyyo.com/manager/1.0/services/33175434051/cti_plugins"
},
"enabled_cti_plugins": {
"href": "https://api.keyyo.com/manager/1.0/services/33175434051/enabled_cti_plugins"
},
"blacklist": {
"href": "https://api.keyyo.com/manager/1.0/services/33175434051/blacklist"
},
"profiles": {
"href": "https://api.keyyo.com/manager/1.0/services/33175434051/profiles"
}
},
"_resource_type": "UCaaSVoIPAccount",
"csi": "33175434051",
"formatted_csi": "+33175434051",
"name": "外篇",
"offer_id": 473,
"offer_name": "Illimité Mobile Centrex 1 - 24mois",
"commitment_start_date": "2014-07-11",
"status": "in_service",
"blocking_status": null,
"options": [
"sms"
],
"short_number": "4052"
},
{
"_links": {
"self": {
"href": "https://api.keyyo.com/manager/1.0/services/33175430608"
},
"available_upgrades": {
"href": "https://api.keyyo.com/manager/1.0/services/33175430608/available_upgrades"
},
"provisioning_tasks": {
"href": "https://api.keyyo.com/manager/1.0/services/33175430608/provisioning_tasks"
},
"cti_plugins": {
"href": "https://api.keyyo.com/manager/1.0/services/33175430608/cti_plugins"
},
"enabled_cti_plugins": {
"href": "https://api.keyyo.com/manager/1.0/services/33175430608/enabled_cti_plugins"
},
"blacklist": {
"href": "https://api.keyyo.com/manager/1.0/services/33175430608/blacklist"
},
"profiles": {
"href": "https://api.keyyo.com/manager/1.0/services/33175430608/profiles"
}
},
"_resource_type": "UCaaSVoIPAccount",
"csi": "33175430608",
"formatted_csi": "+33175430608",
"name": "Fax Comptabilité",
"offer_id": 476,
"offer_name": "Fax IP",
"commitment_start_date": null,
"status": "cancellation_pending",
"blocking_status": "pending",
"options": {},
"short_number": "1608"
},
{
"_links": {
"self": {
"href": "https://api.keyyo.com/manager/1.0/services/33175438235"
},
"available_upgrades": {
"href": "https://api.keyyo.com/manager/1.0/services/33175438235/available_upgrades"
},
"provisioning_tasks": {
"href": "https://api.keyyo.com/manager/1.0/services/33175438235/provisioning_tasks"
},
"cti_plugins": {
"href": "https://api.keyyo.com/manager/1.0/services/33175438235/cti_plugins"
},
"enabled_cti_plugins": {
"href": "https://api.keyyo.com/manager/1.0/services/33175438235/enabled_cti_plugins"
},
"blacklist": {
"href": "https://api.keyyo.com/manager/1.0/services/33175438235/blacklist"
},
"profiles": {
"href": "https://api.keyyo.com/manager/1.0/services/33175438235/profiles"
}
},
"_resource_type": "UCaaSVoIPAccount",
"csi": "33175438235",
"formatted_csi": "+33175438235",
"name": "Adeline Arras",
"offer_id": 916,
"offer_name": "Pack Illimité - engagement",
"commitment_start_date": null,
"status": "setup_pending",
"blocking_status": null,
"options": [
"sms"
],
"short_number": "8235"
},
{
"_links": {
"self": {
"href": "https://api.keyyo.com/manager/1.0/services/33175438417"
},
"available_upgrades": {
"href": "https://api.keyyo.com/manager/1.0/services/33175438417/available_upgrades"
},
"provisioning_tasks": {
"href": "https://api.keyyo.com/manager/1.0/services/33175438417/provisioning_tasks"
},
"cti_plugins": {
"href": "https://api.keyyo.com/manager/1.0/services/33175438417/cti_plugins"
},
"enabled_cti_plugins": {
"href": "https://api.keyyo.com/manager/1.0/services/33175438417/enabled_cti_plugins"
},
"blacklist": {
"href": "https://api.keyyo.com/manager/1.0/services/33175438417/blacklist"
},
"profiles": {
"href": "https://api.keyyo.com/manager/1.0/services/33175438417/profiles"
}
},
"_resource_type": "UCaaSVoIPAccount",
"csi": "33175438417",
"formatted_csi": "+33175438417",
"name": "Adeline Arras",
"offer_id": 918,
"offer_name": "Pack Illimité Mobile - engagement",
"commitment_start_date": "2015-04-02",
"status": "in_service",
"blocking_status": null,
"options": [
"sms",
"supervision"
],
"short_number": "8417"
}
],
"EmailAccount": [
{
"_links": {
"self": {
"href": "https://api.keyyo.com/manager/1.0/services/pmarley%40keyyomail.com"
},
"available_upgrades": {
"href": "https://api.keyyo.com/manager/1.0/services/pmarley@keyyomail.com/available_upgrades"
},
"provisioning_tasks": {
"href": "https://api.keyyo.com/manager/1.0/services/pmarley@keyyomail.com/provisioning_tasks"
}
},
"_resource_type": "EmailAccount",
"csi": "pmarley@keyyomail.com",
"formatted_csi": "pmarley@keyyomail.com",
"name": "Pascal marley",
"offer_id": 800,
"offer_name": "Email Keyyo",
"commitment_start_date": null,
"status": "in_service",
"blocking_status": null,
"options": {},
"first_name": "Pascal",
"last_name": "marley",
"quota": "1073741824"
}
]
}
}
<?php
require_once('lib/Keyyo/autoload.php');
$access_token = 'YOUR_ACCESS_TOKEN';
$client = new \Keyyo\Manager\Client('1.0', $access_token);
$services = $client->services();
foreach ($services as $service)
echo $service->offer_name;
curl --header "Authorization: Bearer YOUR_ACCESS_TOKEN" -H "Accept: application/xml" https://api.keyyo.com/manager/1.0/services
<?xml version="1.0"?>
<resource href="https://api.keyyo.com/manager/1.0/services">
<resource href="https://api.keyyo.com/manager/1.0/services/33175430359" rel="ACDService">
<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>
<resource href="https://api.keyyo.com/manager/1.0/services/33988994158" rel="ACDService">
<link href="https://api.keyyo.com/manager/1.0/services/33988994158/available_upgrades" rel="available_upgrades"/>
<link href="https://api.keyyo.com/manager/1.0/services/33988994158/provisioning_tasks" rel="provisioning_tasks"/>
<_resource_type>ACDService</_resource_type>
<csi>33988994158</csi>
<formatted_csi>+33988994158</formatted_csi>
<name>Accueil 2</name>
<offer_id>21</offer_id>
<offer_name>Groupe d'appel</offer_name>
<commitment_start_date/>
<status>setup_pending</status>
<blocking_status/>
<options/>
</resource>
<resource href="https://api.keyyo.com/manager/1.0/services/33974771733" rel="ACDService">
<link href="https://api.keyyo.com/manager/1.0/services/33974771733/available_upgrades" rel="available_upgrades"/>
<link href="https://api.keyyo.com/manager/1.0/services/33974771733/provisioning_tasks" rel="provisioning_tasks"/>
<_resource_type>ACDService</_resource_type>
<csi>33974771733</csi>
<formatted_csi>+33974771733</formatted_csi>
<name>Accueil 4</name>
<offer_id>21</offer_id>
<offer_name>Groupe d'appel</offer_name>
<commitment_start_date/>
<status>setup_pending</status>
<blocking_status/>
<options/>
</resource>
<resource href="https://api.keyyo.com/manager/1.0/services/33362275290" rel="ACDService">
<link href="https://api.keyyo.com/manager/1.0/services/33362275290/available_upgrades" rel="available_upgrades"/>
<link href="https://api.keyyo.com/manager/1.0/services/33362275290/provisioning_tasks" rel="provisioning_tasks"/>
<_resource_type>ACDService</_resource_type>
<csi>33362275290</csi>
<formatted_csi>+33362275290</formatted_csi>
<name>Numéro d'accueil</name>
<offer_id>21</offer_id>
<offer_name>Groupe d'appel</offer_name>
<commitment_start_date/>
<status>setup_pending</status>
<blocking_status/>
<options/>
</resource>
<resource href="https://api.keyyo.com/manager/1.0/services/33481915570" rel="ACDService">
<link href="https://api.keyyo.com/manager/1.0/services/33481915570/available_upgrades" rel="available_upgrades"/>
<link href="https://api.keyyo.com/manager/1.0/services/33481915570/provisioning_tasks" rel="provisioning_tasks"/>
<_resource_type>ACDService</_resource_type>
<csi>33481915570</csi>
<formatted_csi>+33481915570</formatted_csi>
<name>Numéro d'accueil</name>
<offer_id>21</offer_id>
<offer_name>Groupe d'appel</offer_name>
<commitment_start_date/>
<status>in_service</status>
<blocking_status/>
<options/>
</resource>
<resource href="https://api.keyyo.com/manager/1.0/services/33811030854" rel="NumberTranslation">
<link href="https://api.keyyo.com/manager/1.0/services/33811030854/available_upgrades" rel="available_upgrades"/>
<link href="https://api.keyyo.com/manager/1.0/services/33811030854/provisioning_tasks" rel="provisioning_tasks"/>
<_resource_type>NumberTranslation</_resource_type>
<csi>33811030854</csi>
<formatted_csi>+33811030854</formatted_csi>
<name>Accueil 1 en 08</name>
<offer_id>247</offer_id>
<offer_name>8016 - Numéro Spécial online</offer_name>
<commitment_start_date/>
<status>suspended</status>
<blocking_status>blocked</blocking_status>
<options/>
</resource>
<resource href="https://api.keyyo.com/manager/1.0/services/33811030874" rel="NumberTranslation">
<link href="https://api.keyyo.com/manager/1.0/services/33811030874/available_upgrades" rel="available_upgrades"/>
<link href="https://api.keyyo.com/manager/1.0/services/33811030874/provisioning_tasks" rel="provisioning_tasks"/>
<_resource_type>NumberTranslation</_resource_type>
<csi>33811030874</csi>
<formatted_csi>+33811030874</formatted_csi>
<name>Accueil 2 en 08</name>
<offer_id>247</offer_id>
<offer_name>8016 - Numéro Spécial online</offer_name>
<commitment_start_date/>
<status>suspended</status>
<blocking_status>blocked</blocking_status>
<options/>
</resource>
<resource href="https://api.keyyo.com/manager/1.0/services/33811261598" rel="NumberTranslation">
<link href="https://api.keyyo.com/manager/1.0/services/33811261598/available_upgrades" rel="available_upgrades"/>
<link href="https://api.keyyo.com/manager/1.0/services/33811261598/provisioning_tasks" rel="provisioning_tasks"/>
<_resource_type>NumberTranslation</_resource_type>
<csi>33811261598</csi>
<formatted_csi>+33811261598</formatted_csi>
<name>Test créa MC 1</name>
<offer_id>247</offer_id>
<offer_name>8016 - Numéro Spécial online</offer_name>
<commitment_start_date/>
<status>suspended</status>
<blocking_status>blocked</blocking_status>
<options/>
</resource>
<resource href="https://api.keyyo.com/manager/1.0/services/33175434051" rel="UCaaSVoIPAccount">
<link href="https://api.keyyo.com/manager/1.0/services/33175434051/available_upgrades" rel="available_upgrades"/>
<link href="https://api.keyyo.com/manager/1.0/services/33175434051/provisioning_tasks" rel="provisioning_tasks"/>
<link href="https://api.keyyo.com/manager/1.0/services/33175434051/cti_plugins" rel="cti_plugins"/>
<link href="https://api.keyyo.com/manager/1.0/services/33175434051/enabled_cti_plugins" rel="enabled_cti_plugins"/>
<link href="https://api.keyyo.com/manager/1.0/services/33175434051/blacklist" rel="blacklist"/>
<link href="https://api.keyyo.com/manager/1.0/services/33175434051/profiles" rel="profiles"/>
<_resource_type>UCaaSVoIPAccount</_resource_type>
<csi>33175434051</csi>
<formatted_csi>+33175434051</formatted_csi>
<name>外篇</name>
<offer_id>473</offer_id>
<offer_name>Illimité Mobile Centrex 1 - 24mois</offer_name>
<commitment_start_date>2014-07-11</commitment_start_date>
<status>in_service</status>
<blocking_status/>
<options>
<options>sms</options>
</options>
<short_number>4052</short_number>
</resource>
<resource href="https://api.keyyo.com/manager/1.0/services/33175430608" rel="UCaaSVoIPAccount">
<link href="https://api.keyyo.com/manager/1.0/services/33175430608/available_upgrades" rel="available_upgrades"/>
<link href="https://api.keyyo.com/manager/1.0/services/33175430608/provisioning_tasks" rel="provisioning_tasks"/>
<link href="https://api.keyyo.com/manager/1.0/services/33175430608/cti_plugins" rel="cti_plugins"/>
<link href="https://api.keyyo.com/manager/1.0/services/33175430608/enabled_cti_plugins" rel="enabled_cti_plugins"/>
<link href="https://api.keyyo.com/manager/1.0/services/33175430608/blacklist" rel="blacklist"/>
<link href="https://api.keyyo.com/manager/1.0/services/33175430608/profiles" rel="profiles"/>
<_resource_type>UCaaSVoIPAccount</_resource_type>
<csi>33175430608</csi>
<formatted_csi>+33175430608</formatted_csi>
<name>Fax Comptabilité</name>
<offer_id>476</offer_id>
<offer_name>Fax IP</offer_name>
<commitment_start_date/>
<status>cancellation_pending</status>
<blocking_status>pending</blocking_status>
<options/>
<short_number>1608</short_number>
</resource>
<resource href="https://api.keyyo.com/manager/1.0/services/33175438235" rel="UCaaSVoIPAccount">
<link href="https://api.keyyo.com/manager/1.0/services/33175438235/available_upgrades" rel="available_upgrades"/>
<link href="https://api.keyyo.com/manager/1.0/services/33175438235/provisioning_tasks" rel="provisioning_tasks"/>
<link href="https://api.keyyo.com/manager/1.0/services/33175438235/cti_plugins" rel="cti_plugins"/>
<link href="https://api.keyyo.com/manager/1.0/services/33175438235/enabled_cti_plugins" rel="enabled_cti_plugins"/>
<link href="https://api.keyyo.com/manager/1.0/services/33175438235/blacklist" rel="blacklist"/>
<link href="https://api.keyyo.com/manager/1.0/services/33175438235/profiles" rel="profiles"/>
<_resource_type>UCaaSVoIPAccount</_resource_type>
<csi>33175438235</csi>
<formatted_csi>+33175438235</formatted_csi>
<name>Adeline Arras</name>
<offer_id>916</offer_id>
<offer_name>Pack Illimité - engagement</offer_name>
<commitment_start_date/>
<status>setup_pending</status>
<blocking_status/>
<options>
<options>sms</options>
</options>
<short_number>8235</short_number>
</resource>
<resource href="https://api.keyyo.com/manager/1.0/services/33175438417" rel="UCaaSVoIPAccount">
<link href="https://api.keyyo.com/manager/1.0/services/33175438417/available_upgrades" rel="available_upgrades"/>
<link href="https://api.keyyo.com/manager/1.0/services/33175438417/provisioning_tasks" rel="provisioning_tasks"/>
<link href="https://api.keyyo.com/manager/1.0/services/33175438417/cti_plugins" rel="cti_plugins"/>
<link href="https://api.keyyo.com/manager/1.0/services/33175438417/enabled_cti_plugins" rel="enabled_cti_plugins"/>
<link href="https://api.keyyo.com/manager/1.0/services/33175438417/blacklist" rel="blacklist"/>
<link href="https://api.keyyo.com/manager/1.0/services/33175438417/profiles" rel="profiles"/>
<_resource_type>UCaaSVoIPAccount</_resource_type>
<csi>33175438417</csi>
<formatted_csi>+33175438417</formatted_csi>
<name>Adeline Arras</name>
<offer_id>918</offer_id>
<offer_name>Pack Illimité Mobile - engagement</offer_name>
<commitment_start_date>2015-04-02</commitment_start_date>
<status>in_service</status>
<blocking_status/>
<options>
<options>sms</options>
<options>supervision</options>
</options>
<short_number>8417</short_number>
</resource>
<resource href="https://api.keyyo.com/manager/1.0/services/pmarley%40keyyomail.com" rel="EmailAccount">
<link href="https://api.keyyo.com/manager/1.0/services/pmarley@keyyomail.com/available_upgrades" rel="available_upgrades"/>
<link href="https://api.keyyo.com/manager/1.0/services/pmarley@keyyomail.com/provisioning_tasks" rel="provisioning_tasks"/>
<_resource_type>EmailAccount</_resource_type>
<csi>pmarley@keyyomail.com</csi>
<formatted_csi>pmarley@keyyomail.com</formatted_csi>
<name>Pascal marley</name>
<offer_id>800</offer_id>
<offer_name>Email Keyyo</offer_name>
<commitment_start_date/>
<status>in_service</status>
<blocking_status/>
<options/>
<first_name>Pascal</first_name>
<last_name>marley</last_name>
<quota>1073741824</quota>
</resource>
</resource>