Complete API reference

Data fields formats
Return messages formats
Error messages formats
Api v.1
    Resellers_accounts
        Get all account add-ons with validity info 
Reseller

        Add addon to account 
Reseller

        Get accounts info for reseller 
Reseller

        Get account info 
Reseller

        Create new account 
Reseller

        Get account status 
Reseller

        Change account status (suspend, unsuspend or terminate) 
Reseller

        Change account variation 
Reseller

        Check account domain before signup 
Reseller

        Check email validity before signup 
Reseller

        Get all reseller variations 
Reseller

    Resellers_accounts_attributes
        Get account attribute 
Reseller

        Change account attribute 
Reseller

    Resellers_accounts_users
        Remove user from account 
Reseller

        Get users list from account 
Reseller

    Resellers_licenses
        Get all license add-ons with validity info 
Reseller

        Add addon to license 
Reseller

        Change addon validity on owned license 
Reseller

        Get all licenses info for reseller 
Reseller

    Resellers_license_attributes
        Get license attribute 
Reseller

        Change license attribute 
Reseller


Datafield formats

 
Type Description
datetime valid format: YYYY-MM-DD HH:MM:SS. Note: LiveAgent uses "America/Los_Angeles" timezone by default.
text could be any string or empty
constlist could by only one instance of a finite set. Possible values are named in specific field description.
int integer value.
list list of entities. Every entity has its specific column definition.
float float value.


Return messages formats


Return messages are in JSON format by default. But you can change this to XML by adding .xml at the end of call URL.This will give a response in JSON:
GET
  http://example.com/api/agents/john@agent.com

We add .xml to call URL and we have response in XML format
GET
  http://example.com/api/agents/john@agent.com.xml

Note: if you have PHP YAML extension enabled in your PHP, you could also use .yaml to get a response in YAML format.

Error messages formats


400 - Common processing error
This is the most common error type. You can get this in case "parameter message is missing" or "unable to load conversation"

401 - Forbidden
You can get this in case of failed authentification with the wrong key

404 - Not found error
You can get this in case "agent with email agent@email.com not found"

500 - Fatal server error
You can get this error when something goes wrong on the server

503 - Service Unavailable
You can get this in case application is unavailable to process requests - in case of updating and/or installing.
 
Error response example
XML
<?xml version="1.0" encoding="utf-8"?>
<response>
 <status>ERROR</status>
 <statuscode>500</statuscode>
 <errormessage>Example error message</errormessage>
 <debugmessage>debug info</debugmessage>
</response>
JSON
{
  "response":{
    "status":"ERROR",
    "statuscode":500,
    "errormessage":"Example error message",
    "debugmessage":"debug info"
  }
}

API version 1


Resellers_accounts


Get all account add-ons with validity info

Available from application version: 1.0.0.0

Allowed role
Reseller
 This call is available only to Resellers

Example call
GET
  http://example.com/api/resellers/[reselleridentifier]/accounts/[account_id]/addons?apikey=[value]
 

Mandatory parameters

Name Type Description
[reselleridentifier] text Reseller identifier (email or userid)
[account_id] text Account identifier
apikey text API key


Call response description
 

Return fields

Name Type Description
addons list Addons list
Field addons has 8 columns:
id text Addon id
description text Addon description
name text Addon name
price float Addon price
valid_from datetime Addon validity from
valid_to datetime Addon validity to
license_code datetime Addon license code
status constlist Addon status (Possible values: A - Approved, R - Refunded)
 
Example responses
XML
<?xml version="1.0" encoding="utf-8"?>
<response>
 <addons>
  <addon>
   <id>abg7y8e4</id>
   <description>Proactive chat</description>
   <name>Proactive chat</name>
   <price>99.90</price>
   <valid_from>2009-11-12 15:21:32</valid_from>
   <valid_to/>
   <license_code>ss5l5sa6</license_code>
   <status>A</status>
  </addon>
  <addon>
   <id>t7f7y4gt</id>
   <description>Gamification</description>
   <name>Gamification</name>
   <price>19.40</price>
   <valid_from>2009-11-12 15:21:32</valid_from>
   <valid_to>2010-10-08 12:15:48</valid_to>
   <license_code>g7s86aa8</license_code>
   <status>A</status>
  </addon>
 </addons>
</response>
JSON
{
  "response":{
    "addons":[
      {
        "id":"abg7y8e4",
        "description":"Proactive chat",
        "name":"Proactive chat",
        "price":"99.90",
        "valid_from":"2009-11-12 15:21:32",
        "valid_to":null,
        "license_code":"ss5l5sa6",
        "status":"A"
      },
      {
        "id":"t7f7y4gt",
        "description":"Gamification",
        "name":"Gamification",
        "price":"19.40",
        "valid_from":"2009-11-12 15:21:32",
        "valid_to":"2010-10-08 12:15:48",
        "license_code":"g7s86aa8",
        "status":"A"
      }
    ]
  }
}


Add addon to account

Available from application version: 1.0.0.0

Allowed role
Reseller
 This call is available only to Resellers

Example call
POST
  http://example.com/api/resellers/[reselleridentifier]/accounts/[account_id]/addons
Note: You must send parameters for this call as POST fields.
 

Mandatory parameters

Name Type Description
[reselleridentifier] text Reseller identifier (email or userid)
[account_id] text Account identifier
addon_id text Id of addon
apikey text API key
 

Optional parameters

Name Type Description
valid_to datetime Validity date


Call response description
 

Return fields

Name Type Description
status text OK
statuscode int Status code of executed request
 
Example responses
XML
<?xml version="1.0" encoding="utf-8"?>
<response>
 <status>OK</status>
 <statuscode>0</statuscode>
</response>
JSON
{
  "response":{
    "status":"OK",
    "statuscode":0
  }
}


Get accounts info for reseller

Available from application version: 1.0.0.0
Available examples: PHP example

Allowed role
Reseller
 This call is available only to Resellers

Example call
GET
  http://example.com/api/resellers/[reselleridentifier]/accounts?apikey=[value]
 

Mandatory parameters

Name Type Description
[reselleridentifier] text Reseller identifier (email or userid)
apikey text API key
 

Optional parameters

Name Type Description
created_from datetime Laod accounts info from this date
created_to datetime Laod accounts info to this date


Call response description
 

Return fields

Name Type Description
accounts list accounts list
Field accounts has 10 columns:
customer_email text Customer email
account_id text Account identifier
domain text Account full domain
customer_name text Customer email
company text Company
date_created datetime Date created
variation_id text Id of assigned variation to this account
status constlist Account status (Possible values: a - Active, s - Suspended, t - Terminated, n - New, b - Broken, c - Waiting for create)
version text Account version
last_login_date datetime Last login date of customer to the account
 
Example responses
XML
<?xml version="1.0" encoding="utf-8"?>
<response>
 <accounts>
  <account>
   <customer_email>john@example.com</customer_email>
   <account_id>9900a49c321c871cd1a572a1dc21a33c</account_id>
   <domain>mysupport.ladesk.com</domain>
   <customer_name>John Oniell</customer_name>
   <company>QualityUnit</company>
   <date_created>2012-11-10 07:12:51</date_created>
   <variation_id>t7f4u7fd</variation_id>
   <status>a</status>
   <version>4.0.5.1</version>
   <last_login_date>2013-01-10 07:12:51</last_login_date>
  </account>
  <account>
   <customer_email>marcus@sonatha.com</customer_email>
   <account_id>f7u4g79c321cf77td1a572a1dcg7uyf4</account_id>
   <domain>sonatha.ladesk.com</domain>
   <customer_name>Marcus Dough</customer_name>
   <company>Sonatha</company>
   <date_created>2013-02-10 07:12:51</date_created>
   <variation_id>7h4r7s54</variation_id>
   <status>s</status>
   <version>4.0.4.1</version>
   <last_login_date>2013-03-10 07:12:51</last_login_date>
  </account>
 </accounts>
</response>
JSON
{
  "response":{
    "accounts":[
      {
        "customer_email":"john@example.com",
        "account_id":"9900a49c321c871cd1a572a1dc21a33c",
        "domain":"mysupport.ladesk.com",
        "customer_name":"John Oniell",
        "company":"QualityUnit",
        "date_created":"2012-11-10 07:12:51",
        "variation_id":"t7f4u7fd",
        "status":"a",
        "version":"4.0.5.1",
        "last_login_date":"2013-01-10 07:12:51"
      },
      {
        "customer_email":"marcus@sonatha.com",
        "account_id":"f7u4g79c321cf77td1a572a1dcg7uyf4",
        "domain":"sonatha.ladesk.com",
        "customer_name":"Marcus Dough",
        "company":"Sonatha",
        "date_created":"2013-02-10 07:12:51",
        "variation_id":"7h4r7s54",
        "status":"s",
        "version":"4.0.4.1",
        "last_login_date":"2013-03-10 07:12:51"
      }
    ]
  }
}


Get account info

Available from application version: 1.0.0.0

Allowed role
Reseller
 This call is available only to Resellers

Example call
GET
  http://example.com/api/resellers/[reselleridentifier]/accounts/[account_id]?apikey=[value]
 

Mandatory parameters

Name Type Description
[reselleridentifier] text Reseller identifier (email or userid)
[account_id] text Account identifier
apikey text API key


Call response description
 

Return fields

Name Type Description
customer_email text Customer email
account_id text Account identifier
domain text Account full domain
customer_name text Customer email
company text Company
date_created datetime Date created
variation_id text Id of assigned variation to this account
status constlist Account status (Possible values: a - Active, s - Suspended, t - Terminated, n - New, b - Broken, c - Waiting for create)
version text Account version
last_login_date datetime Last login date of customer to the account
 
Example responses
XML
<?xml version="1.0" encoding="utf-8"?>
<response>
 <customer_email/>
 <account_id/>
 <domain/>
 <customer_name/>
 <company/>
 <date_created/>
 <variation_id/>
 <status/>
 <version/>
 <last_login_date/>
</response>
JSON
{
  "response":{
    "customer_email":null,
    "account_id":null,
    "domain":null,
    "customer_name":null,
    "company":null,
    "date_created":null,
    "variation_id":null,
    "status":null,
    "version":null,
    "last_login_date":null
  }
}


Create new account

Available from application version: 1.0.0.0

Allowed role
Reseller
 This call is available only to Resellers

Example call
POST
  http://example.com/api/resellers/[reselleridentifier]/accounts
Note: You must send parameters for this call as POST fields.
 

Mandatory parameters

Name Type Description
[reselleridentifier] text Reseller identifier (email or userid)
variation_id text Reseller variation id
customer_email text Customer email
customer_name text Customer name
subdomain text Subdomain name
apikey text API key
 

Optional parameters

Name Type Description
company text Company name
top_domain text Top domain name, default one ladesk.com will be used if not set
language text Preffered language. If not set, the english language will be used
extra_params text Extra signup params - must be JSON string. Possible extra param names are: "phone" (optional phone of the customer)


Call response description
 

Return fields

Name Type Description
status text OK
statuscode int Status code of executed request
account_id text New account id
account_status constlist Account status (Possible values: n - New, c - Waiting for create)
 
Example responses
XML
<?xml version="1.0" encoding="utf-8"?>
<response>
 <status>OK</status>
 <statuscode>0</statuscode>
 <account_id>9900a49c321c871cd1a572a1dc21a33c</account_id>
 <account_status>c</account_status>
</response>
JSON
{
  "response":{
    "status":"OK",
    "statuscode":0,
    "account_id":"9900a49c321c871cd1a572a1dc21a33c",
    "account_status":"c"
  }
}


Get account status

Available from application version: 1.0.0.0

Allowed role
Reseller
 This call is available only to Resellers

Example call
GET
  http://example.com/api/resellers/[reselleridentifier]/accounts/[account_id]/status?apikey=[value]
 

Mandatory parameters

Name Type Description
[reselleridentifier] text Reseller identifier (email or userid)
[account_id] text Account identifier
apikey text API key


Call response description
 

Return fields

Name Type Description
account_status constlist Account status (Possible values: a - Active, s - Suspended, t - Terminated, n - New, b - Broken, c - Waiting for create, r - Crashed, m - Wait for manual unsuspend, p - Wait for suspend, d - Wait for termination, u - Wait for unsuspend, v - Wait for update)
 
Example responses
XML
<?xml version="1.0" encoding="utf-8"?>
<response>
 <account_status/>
</response>
JSON
{
  "response":{
    "account_status":null
  }
}


Change account status (suspend, unsuspend or terminate)

Available from application version: 1.0.0.0

Allowed role
Reseller
 This call is available only to Resellers

Example call
PUT
  http://example.com/api/resellers/[reselleridentifier]/accounts/[account_id]/status
Note: You must send parameters for this call as PUT fields.
 

Mandatory parameters

Name Type Description
[reselleridentifier] text Reseller identifier (email or userid)
[account_id] text Account identifier
status constlist Account will be updated to this status (Possible values: a - Active, s - Suspended, t - Terminated)
note text Account status change note
apikey text API key


Call response description
 

Return fields

Name Type Description
status text OK
statuscode int Status code of executed request
 
Example responses
XML
<?xml version="1.0" encoding="utf-8"?>
<response>
 <status>OK</status>
 <statuscode>0</statuscode>
</response>
JSON
{
  "response":{
    "status":"OK",
    "statuscode":0
  }
}


Change account variation

Avaliable from application version: 1.0.0.0

Allowed role
Reseller
 This call is available only to Resellers

Example call
PUT
  http://example.com/api/resellers/[reselleridentifier]/accounts/[account_id]/variation
Note: You must send parameters for this call as PUT fields.
 

Mandatory parameters

Name Type Description
[reselleridentifier] text Reseller identifier (email or userid)
[account_id] text Account identifier
variationid text Account will be updated to this variation
apikey text API key
 

Optional parameters

Name Type Description
variation_params text Extra variation params separated by comma.


Call response description
 

Return fields

Name Type Description
status text OK
statuscode int Status code of executed request
 
Example responses
XML
<?xml version="1.0" encoding="utf-8"?>
<response>
 <status>OK</status>
 <statuscode>0</statuscode>
</response>
JSON
{
  "response":{
    "status":"OK",
    "statuscode":0
  }
}


Check account domain before signup

Avaliable from application version: 1.0.0.0

Allowed role
Reseller
 This call is available only to Resellers

Example call
GET
  http://example.com/api/resellers/[reselleridentifier]/signupcheck/domain?productid=[value]&subdomain=[value]&apikey=[value]
 

Mandatory parameters

Name Type Description
[reselleridentifier] text Reseller identifier (email or userid)
productid text Product id
subdomain text desired subdomain name
apikey text API key
 

Optional parameters

Name Type Description
customtopdomain text Top domain name. Default value is ladesk.com or postaffiliatepro.com accourding to productid


Call response description
 

Return fields

Name Type Description
is_valid text  
error text  
 
Example responses
XML
<?xml version="1.0" encoding="utf-8"?>
<response>
 <is_valid/>
 <error/>
</response>
JSON
{
  "response":{
    "is_valid":null,
    "error":null
  }
}


Check email validity before signup

Avaliable from application version: 1.0.0.0

Allowed role
Reseller
 This call is available only to Resellers

Example call
GET
  http://example.com/api/resellers/[reselleridentifier]/signupcheck/email?productid=[value]&email=[value]&apikey=[value]
 

Mandatory parameters

Name Type Description
[reselleridentifier] text Reseller identifier (email or userid)
productid text Product id
email text desired email
apikey text API key


Call response description
 

Return fields

Name Type Description
is_valid text  
error text  
 
Example responses
XML
<?xml version="1.0" encoding="utf-8"?>
<response>
 <is_valid/>
 <error/>
</response>
JSON
{
  "response":{
    "is_valid":null,
    "error":null
  }
}


Get all reseller variations

Available from application version: 1.0.0.0
Available examples: PHP example

Allowed role
Reseller
 This call is available only to Resellers

Example call
GET
  http://example.com/api/resellers/[reselleridentifier]/variations?apikey=[value]
 

Mandatory parameters

Name Type Description
[reselleridentifier] text Reseller identifier (email or userid)
apikey text API key


Call response description
 

Return fields

Name Type Description
variations list Variations list
Field variations has 6 columns:
name text Variation name
id text Variation identifier
created datetime Variation created date
description text Variation description
product text Variation product
addons list Variation addons list
Field addons has 4 columns:
name text Name of the addon
id text Addon identifer
price float Addon price
description text Addon description
 
Example responses
XML
<?xml version="1.0" encoding="utf-8"?>
<response>
 <variations>
  <variation>
   <name>Free</name>
   <id>r7g4y7ya</id>
   <created>2012-05-04 11:15:14</created>
   <description>Free variation. No restrictions.</description>
   <product>LiveAgent</product>
   <addons>
    <addon>
     <name>Proactive chat</name>
     <id>p4g7y4ft7</id>
     <price>99.90</price>
     <description>Proactive chat</description>
    </addon>
    <addon>
     <name>Gamification</name>
     <id>p9t5s4s5</id>
     <price>19.40</price>
     <description>Gamification</description>
    </addon>
   </addons>
  </variation>
 </variations>
</response>
JSON
{
  "response":{
    "variations":[
      {
        "name":"Free",
        "id":"r7g4y7ya",
        "created":"2012-05-04 11:15:14",
        "description":"Free variation. No restrictions.",
        "product":"LiveAgent",
        "addons":[
          {
            "name":"Proactive chat",
            "id":"p4g7y4ft7",
            "price":"99.90",
            "description":"Proactive chat"
          },
          {
            "name":"Gamification",
            "id":"p9t5s4s5",
            "price":"19.40",
            "description":"Gamification"
          }
        ]
      }
    ]
  }
}



Resellers_accounts_attributes


Get account attribute

Available from application version: 1.0.0.0

Allowed role
Reseller
 This call is available only to Resellers

Example call
GET
  http://example.com/api/resellers/[reselleridentifier]/accounts/[account_id]/attributes/[attribute_name]?apikey=[value]
 

Mandatory parameters

Name Type Description
[reselleridentifier] text Reseller identifier (email or userid)
[account_id] text Account identifier
[attribute_name] text Attribute identifier. Currently supported attributes: max_agents
apikey text API key


Call response description
 

Return fields

Name Type Description
value text Attribute value. Currently supported attributes names: max_agents
 
Example responses
XML
<?xml version="1.0" encoding="utf-8"?>
<response>
 <value>99</value>
</response>
JSON
{
  "response":{
    "value":"99"
  }
}


Change account attribute

Available from application version: 1.0.0.0

Allowed role
Reseller
 This call is available only to Resellers

Example call
PUT
  http://example.com/api/resellers/[reselleridentifier]/accounts/[account_id]/attributes/[attribute_name]
Note: You must send parameters for this call as PUT fields.
 

Mandatory parameters

Name Type Description
[reselleridentifier] text Reseller identifier (email or userid)
[account_id] text Account identifier
[attribute_name] text Attribute identifier. Currently supported attributes: max_agents
value text Attribute value
apikey text API key


Call response description
 

Return fields

Name Type Description
status text OK
statuscode int Status code of executed request
 
Example responses
XML
<?xml version="1.0" encoding="utf-8"?>
<response>
 <status>OK</status>
 <statuscode>0</statuscode>
</response>
JSON
{
  "response":{
    "status":"OK",
    "statuscode":0
  }
}



Resellers_accounts_users


Remove user from account

Available from application version: 1.0.0.0

Allowed role
Reseller
 This call is available only to Resellers

Example call
DELETE
  http://example.com/api/resellers/[reselleridentifier]/accounts/[account_id]/users/[userid]?apikey=[value]
 

Mandatory parameters

Name Type Description
[reselleridentifier] text Reseller identifier (email or userid)
[account_id] text Account identifier
[userid] text User identifier. Can be userid.
apikey text API key


Call response description
 

Return fields

Name Type Description
status text OK
statuscode int Status code of executed request
 
Example responses
XML
<?xml version="1.0" encoding="utf-8"?>
<response>
 <status>OK</status>
 <statuscode>0</statuscode>
</response>
JSON
{
  "response":{
    "status":"OK",
    "statuscode":0
  }
}


Get users list from account

Available from application version: 1.0.0.0

Allowed role
Reseller
 This call is available only to Resellers

Example call
GET
  http://example.com/api/resellers/[reselleridentifier]/accounts/[account_id]/users?apikey=[value]
 

Mandatory parameters

Name Type Description
[reselleridentifier] text Reseller identifier (email or userid)
[account_id] text Account identifier
apikey text API key


Call response description
 

Return fields

Name Type Description
users list users list
Field users has 8 columns:
userid text Id of agent, also known as userid.
email text Agent email.
firstname text Agent first name.
lastname text Agent last name.
role text Agent role.
status text Agent status.
role_type text Agent role type
date_created datetime Date created
 
Example responses
XML
<?xml version="1.0" encoding="utf-8"?>
<response>
 <users>
  <user>
   <userid>user456</userid>
   <email>user@example.com</email>
   <firstname>John</firstname>
   <lastname>User</lastname>
   <role>Owner</role>
   <status>A</status>
   <role_type>la_own</role_type>
   <date_created>2013-05-04 12:22:11</date_created>
  </user>
 </users>
</response>
JSON
{
  "response":{
    "users":[
      {
        "userid":"user456",
        "email":"user@example.com",
        "firstname":"John",
        "lastname":"User",
        "role":"Owner",
        "status":"A",
        "role_type":"la_own",
        "date_created":"2013-05-04 12:22:11"
      }
    ]
  }
}



Resellers_licenses


Get all license add-ons with validity info

Available from application version: 1.0.0.0

Allowed role
Reseller
 This call is available only to Resellers

Example call
GET
  http://example.com/api/resellers/[reselleridentifier]/licenses/[license_code]/addons?apikey=[value]
 

Mandatory parameters

Name Type Description
[reselleridentifier] text Reseller identifier (email or userid)
[license_code] text Account identifier
apikey text API key


Call response description
 

Return fields

Name Type Description
addons list Addons list
Field addons has 8 columns:
id text Addon id
description text Addon description
name text Addon name
price float Addon price
valid_from datetime Addon validity from
valid_to datetime Addon validity to
license_code datetime Addon license code
status constlist Addon status (Possible values: A - Approved, R - Refunded)
 
Example responses
XML
<?xml version="1.0" encoding="utf-8"?>
<response>
 <addons>
  <addon>
   <id>abg7y8e4</id>
   <description>Proactive chat</description>
   <name>Proactive chat</name>
   <price>99.90</price>
   <valid_from>2009-11-12 15:21:32</valid_from>
   <valid_to/>
   <license_code>ss5l5sa6</license_code>
   <status>A</status>
  </addon>
  <addon>
   <id>t7f7y4gt</id>
   <description>Gamification</description>
   <name>Gamification</name>
   <price>19.40</price>
   <valid_from>2009-11-12 15:21:32</valid_from>
   <valid_to>2010-10-08 12:15:48</valid_to>
   <license_code>g7s86aa8</license_code>
   <status>A</status>
  </addon>
 </addons>
</response>
JSON
{
  "response":{
    "addons":[
      {
        "id":"abg7y8e4",
        "description":"Proactive chat",
        "name":"Proactive chat",
        "price":"99.90",
        "valid_from":"2009-11-12 15:21:32",
        "valid_to":null,
        "license_code":"ss5l5sa6",
        "status":"A"
      },
      {
        "id":"t7f7y4gt",
        "description":"Gamification",
        "name":"Gamification",
        "price":"19.40",
        "valid_from":"2009-11-12 15:21:32",
        "valid_to":"2010-10-08 12:15:48",
        "license_code":"g7s86aa8",
        "status":"A"
      }
    ]
  }
}


Add addon to license

Available from application version: 1.0.0.0

Allowed role
Reseller
 This call is available only to Resellers

Example call
POST
  http://example.com/api/resellers/[reselleridentifier]/licenses/[license_code]/addons
Note: You must send parameters for this call as POST fields.
 

Mandatory parameters

Name Type Description
[reselleridentifier] text Reseller identifier (email or userid)
[license_code] text Account identifier
addon_id text Id of addon
apikey text API key
 

Optional parameters

Name Type Description
valid_to datetime Validity date


Call response description
 

Return fields

Name Type Description
status text OK
statuscode int Status code of executed request
 
Example responses
XML
<?xml version="1.0" encoding="utf-8"?>
<response>
 <status>OK</status>
 <statuscode>0</statuscode>
</response>
JSON
{
  "response":{
    "status":"OK",
    "statuscode":0
  }
}


Change addon validity on owned license

Available from application version: 1.0.0.0

Allowed role
Reseller
 This call is available only to Resellers

Example call
PUT
  http://example.com/api/resellers/[reselleridentifier]/licenses/[license_code]/addons/[addon_license]/validity
Note: You must send parameters for this call as PUT fields.
 

Mandatory parameters

Name Type Description
[reselleridentifier] text Reseller identifier (email or userid)
[license_code] text Account identifier
[addon_license] text Account identifier
valid_to datetime New valid to date
apikey text API key


Call response description
 

Return fields

Name Type Description
status text OK
statuscode int Status code of executed request
 
Example responses
XML
<?xml version="1.0" encoding="utf-8"?>
<response>
 <status>OK</status>
 <statuscode>0</statuscode>
</response>
JSON
{
  "response":{
    "status":"OK",
    "statuscode":0
  }
}


Get all licenses info for reseller

Available from application version: 1.0.0.0

Allowed role
Reseller
 This call is available only to Resellers

Example call
GET
  http://example.com/api/resellers/[reselleridentifier]/licenses?apikey=[value]
 

Mandatory parameters

Name Type Description
[reselleridentifier] text Reseller identifier (email or userid)
apikey text API key
 

Optional parameters

Name Type Description
valid_from datetime Licenses valid to
valid_to datetime Licenses valid from
customer_identifier text Customer identifier


Call response description
 

Return fields

Name Type Description
licenses list licenses list
Field licenses has 7 columns:
customer_email text Customer email
license_code text License code
valid_from datetime License valid from
customer_name text Customer name
valid_to datetime License valid to
variation_id text Id of assigned variation to this account
license_status constlist License status (Possible values: A - Approved, R - Refunded)
 
Example responses
XML
<?xml version="1.0" encoding="utf-8"?>
<response>
 <licenses>
  <license>
   <customer_email>john@doe.com</customer_email>
   <license_code>lat47ts4</license_code>
   <valid_from>2008-12-11 08:95:41</valid_from>
   <customer_name>John doe</customer_name>
   <valid_to/>
   <variation_id>var4u7y7</variation_id>
   <license_status>A</license_status>
  </license>
 </licenses>
</response>
JSON
{
  "response":{
    "licenses":[
      {
        "customer_email":"john@doe.com",
        "license_code":"lat47ts4",
        "valid_from":"2008-12-11 08:95:41",
        "customer_name":"John doe",
        "valid_to":null,
        "variation_id":"var4u7y7",
        "license_status":"A"
      }
    ]
  }
}



Resellers_license_attributes


Get license attribute

Available from application version: 1.0.0.0

Allowed role
Reseller
 This call is available only to Resellers

Example call
GET
  http://example.com/api/resellers/[reselleridentifier]/licenses/[license_code]/attributes/[attribute_name]?apikey=[value]
 

Mandatory parameters

Name Type Description
[reselleridentifier] text Reseller identifier (email or userid)
[license_code] text Account identifier
[attribute_name] text Attribute identifier. Currently supported attributes: max_agents
apikey text API key


Call response description
 

Return fields

Name Type Description
value text Attribute value. Currently supported attributes names: max_agents
 
Example responses
XML
<?xml version="1.0" encoding="utf-8"?>
<response>
 <value>99</value>
</response>
JSON
{
  "response":{
    "value":"99"
  }
}


Change license attribute

Available from application version: 1.0.0.0

Allowed role
Reseller
 This call is available only to Resellers

Example call
PUT
  http://example.com/api/resellers/[reselleridentifier]/licenses/[license_code]/attributes/[attribute_name]
Note: You must send parameters for this call as PUT fields.
 

Mandatory parameters

Name Type Description
[reselleridentifier] text Reseller identifier (email or userid)
[license_code] text Account identifier
[attribute_name] text Attribute identifier. Currently supported attributes: max_agents
value text Attribute value
apikey text API key


Call response description
 

Return fields

Name Type Description
status text OK
statuscode int Status code of executed request
 
Example responses
XML
<?xml version="1.0" encoding="utf-8"?>
<response>
 <status>OK</status>
 <statuscode>0</statuscode>
</response>
JSON
{
  "response":{
    "status":"OK",
    "statuscode":0
  }
}

 

Ready to try LiveAgent?

It's free for the first 14 days! No credit card required.

Get Started
We work well with others...
Magento Joomla Wordpress Mailchimp
Contact us

support@ladesk.com

+1-800-811-6590 (Toll Free in USA & Canada)

+421 2 33 456 826 (European Union & Worldwide)

Quality Unit, LLC 616 Corporate Way, Suite 2-3278 Valley Cottage, NY 10989

Stay in touch
Blog Google+
© 2004-2015 QualityUnit.com, All rights reserved