Menu

Lumen help

Key

Use these API calls to request important information about your API key.

Description

Returns details of current credit balance for API key and date of next top-up.

Method

GET

Schema location

https://ws.lumen.com/schema/key/v1.0

Base URI

https://ws.lumen.com

URI syntax

/key/(version)

version—Required version.

Example

https://ws.lumen.com/key/v1.0

<?xml version="1.0" encoding="UTF-8"?>
<apikey id="55555" xsi:noNamespaceSchemaLocation= “https://ws.lumen.com/schema/key/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<apiCorrelationId>CDNPortal-1270071184562-8650 </apiCorrelationId>
<assignedAccessGroup id="12345" name="My Access Group"/>
<contact id="2345"name="contactemail@yourcompany.com"/>
<role id="30" name="Reporting"/>
<status>Active</status>
<credits>702</credits>
<next-top-up>2019-12-21 23:43:54 +0000</next-top-up>
</apikey>

Possible status and error messages returned to client

Description

Returns service component IDs and associated subscriber numbers for a given API key scope. This call supports HTTP Delivery version 2.0.

Method

GET

Schema location

https://ws.lumen.com/keySubscriber/v2.0

Base URI

https://ws.lumen.com

URI syntax

/keySubscribers/(version)

version—Required version.

Example

https://ws.lumen.com/keySubscribers/v2.0

{
"subscribers": [
{
"subscriberId": "000004",
"scid": "AABBCC32973"
}
]
}

Possible status and error messages returned to client