API:Get Domain WHOIS

Home / Support / Documentation
Search:
From WHMCS Documentation
Jump to: navigation, search

Contents

Purpose

This command is used to obtain the WHOIS of a domain from the registrar

Attributes

  • domainid - ID of the domain in WHMCS

Example Command

External API

 $postfields["action"] = "domaingetwhoisinfo";
 $postfields["domainid"] = "1";

Internal API

 $command = "domaingetwhoisinfo";
 $adminuser = "admin";
 $values["domainid"] = "1";
 
 $results = localAPI($command,$values,$adminuser);

Successful Response

## XML Response example##
##Results will vary for each registrar and domain extension##

 <whmcsapi version="4.5.1"> 
  <action>domaingetwhoisinfo</action> 
  <result>success</result> 
  <Registrant> 
   <Name>Test Client</Name> 
   <Email>test@testemail.com</Email> 
   <Company>N/A</Company> 
   <Address1>123 Test Street</Address1> 
   <Address2></Address2> 
   <Address3></Address3> 
   <City>Test</City> 
   <State>Test</State> 
   <Zip>TE5 5ST</Zip> 
   <Country>GB</Country> 
   <Tel_Country_Code>44</Tel_Country_Code> 
   <Telephone>123456789</Telephone> 
  </Registrant> 
 </whmcsapi>

Error Response

result = error & message = Domain Not Found # Domain ID not found
result = error & message = Registrar Error Message & error = xxx # Error values

API Functions
Client Management
Add Client - Update Client - Delete Client - Close Client - Get Clients
Get Clients Details - Get Clients Products - Get Clients Password - Add Contact - Update Contact
API:Delete Contact - Update Client Product - Upgrade Product - Validate Login - Send Email
Support Tickets
Get Support Departments - Get Support Statuses - Get Tickets - Get Ticket - Get Ticket Predefined Cats
Get Ticket Predefined Replies - Open Ticket - Reply Ticket - Add Ticket Note - Delete Ticket - Update Ticket
Quotes
Create Quote - Update Quote - Delete Quote - Send Quote - Accept Quote
Module Commands
Module Create - Module Suspend - Module Unsuspend - Module Terminate
Domain Commands
Renew Domain - Get Domain Lock - Get Nameservers - Get WHOIS - Request EPP
Update Lock - Update Nameservers - Update WHOIS - Domain WHOIS Lookup
Order Handling
Get Orders - Get Order Statuses - Add Order - Accept Order - Pending Order - Cancel Order - Fraud Order - Delete Order
Payments/Billing
Get Invoice - Get Payment Methods - Create Invoice - Update Invoice - Add Billable Item - Add Invoice Payment
Add Transaction - Add Credit - Capture Payment
Miscellaneous
Get Activity Log - Get Admin Details - Update Admin Notes - Get Currencies - Get Email Templates
Get To-Do Items - Get To-Do Item Statuses - Get Staff Online - Get Stats - Encrypt Password - Decrypt Password

Retrieved from "http://docs.whmcs.com/API:Get_Domain_WHOIS"