Legacy Keywords

Keyword Lookup

Keyword reservation is based on both GET and POST URL requests.

http://keyword.linkmobility.dk

When you make a request, there will be an HTTP header named X-Status which will either be "success" or "failure", depending on the result of the query.

Parameters

Name

Type

Description

username

Required

The username of the account that executes the lookup

password

Required

The password of the account that executes the lookup

mode

Required

Indicates what action you want to perform, it can take the following values:
check - Checks the availability of keyword and number
reserve - Book the combination of keyword and number
delete - Deletes the combination of keyword and number

lang

 

The language you want the result to be described in, values can be:
da for Danish
en for English
Default: da

number

 

What number should the action be performed on
This parameter is required when you perform a "reserve" or "delete", it must also be indicated if you have filled in the keyword parameter

keyword

 

Which keyword you want to perform the action with

apiurl

 

Indicates the URL we should call when we receive incoming messages to the service. This is defined only when you make a reservation, by which this URL is set up for the API service

random

 

If you are searching for an extended number, you should set this to true if you want a random number

pattern

 

If you search for an extended number, you can filter it using a wildcard search, where * is the wildcard character. You can put this to "true" whereby a series of random numbers will be displayed

limit

 

When you are looking for multiple extended numbers, you can put a limit on how many results you want. Default: 25

statusurl

 

If a shortcode does not allow live reservation, you can define a statusurl which we will call with a value equal confirmed or rejected.

Check Example =

If you want to check if the keyword "KEYWORD" is available on application code 1272, you could use the following url:

Request

http://keyword.linkmobility.dk/?username=xxxx&password=xxxx&number=1272&keyword=KEYWORD&mode=check

Response: available

<?xml version="1.0" encoding="iso-8859-1" ?>
<!DOCTYPE keyword SYSTEM "http://keyword.linkmobility.dk/dtd/keyword.dtd">
<keyword version="1.0">
<status>success</status>
   <result>
      <number>1272</number>
      <keyword>KEYWORD</keyword>
      <status>available</status>
   </result>
</keyword>

Response: taken

<?xml version="1.0" encoding="iso-8859-1" ?>
<!DOCTYPE keyword SYSTEM "http://keyword.linkmobility.dk/dtd/keyword.dtd">
<keyword version="1.0">
<status>failure</status>
   <error>
      <description>Keywordet er optaget</description>
   </error>
</keyword>

Search by number

If you use extended numbers, you can search for available numbers by calling the following url:

http://keyword.linkmobility.dk/?username=xxxx&password=xxxx&mode=check&random=true

To investigate a specific number, you can call the following:

http://keyword.linkmobility.dk/?username=xxxx&password=xxxx&mode=check&number=45609940404040

To find available numbers ending in 321, you can call the following:

http://keyword.linkmobility.dk/?username=xxxx&password=xxxx&mode=check&random=true&pattern=*321

An example where the 3 numbers are available will return the following:

<?xml version="1.0" encoding="iso-8859-1" ?>
<!DOCTYPE keyword SYSTEM "http://keyword.linkmobility.dk/dtd/keyword.dtd">
<keyword version="1.0">
   <status>success</status>
   <result>
      <number>45609940404321</number>
      <status>available</status>
   </result>
   <result>
      <number>45609940405321</number>
      <status>available</status>
   </result>
   <result>
      <number>45609940406321</number>
      <status>available</status>
   </result>
</keyword>

Reserve

Request

http://keyword.linkmobility.dk/?username=xxxx&password=xxxx&number=1272&keyword=KEYWORD&mode=reserve&apiurl=http%3A%2F%2Fyouserver.tld%2Fscript.ext&statusurl=http%3A%2F%2Fyouserver.tld%2Fstatus.ext

If a shortcode does not allow live reservation, you can define a statusurl which we will call with a value equal confirmed or rejected.

Response =

<?xml version="1.0" encoding="iso-8859-1" ?>
<!DOCTYPE keyword SYSTEM "http://keyword.linkmobility.dk/dtd/keyword.dtd">
<keyword version="1.0">
<status>success</status>
   <result>
      <number>1272</number>
      <keyword>KEYWORD</keyword>
      <status>reserved</status>
   </result>
</keyword>

Note that status is now set to "reserved".

Delete a service

Delete a keyword:

Request

http://keyword.linkmobility.dk/?username=xxxx&password=xxxx&number=1272&keyword=KEYWORD&mode=delete

Response =

<?xml version="1.0" encoding="iso-8859-1" ?>
<!DOCTYPE keyword SYSTEM "http://keyword.linkmobility.dk/dtd/keyword.dtd">
<keyword version="1.0">
<status>success</status>
   <result>
      <number>1272</number>
      <keyword>KEYWORD</keyword>
      <status>deleted</status>
   </result>
</keyword>

Delete a number:

Request

http://keyword.linkmobility.dk/?username=xxxx&password=xxxx&number=45609940406321&mode=delete

Response =

<?xml version="1.0" encoding="iso-8859-1" ?>
<!DOCTYPE keyword SYSTEM "http://keyword.linkmobility.dk/dtd/keyword.dtd">
<keyword version="1.0">
<status>success</status>
   <result>
      <number>45609940406321</number>
      <status>deleted</status>
   </result>
</keyword>

List

Request

http://keyword.linkmobility.dk/?username=xxxx&password=xxxx&mode=list

Response =

<?xml version="1.0" encoding="iso-8859-1" ?>
<!DOCTYPE list SYSTEM "http://keyword.linkmobility.dk/dtd/list.dtd">
<list version="1.0">
<status>success</status>
    <result>
        <id>XXXXXX</id>
        <keyword>YY</keyword>
        <number>45609041234567</number>
        <type>longnumber</type>
        <function>HTTP</function>
        <username>USERNAME</username>
    </result>
</list>

For the XML Document, a DTD can be found at http://keyword.linkmobility.dk/dtd/keyword.dtd

Feeling lost? Click on this link! Portal page