get_domains_contacts

Queries the contact information for the specified domains.

Request parameters for get_domains_contacts

Standard parameters

  • action = get_domains_contacts
  • object = domain

Attributes

Parameters within the attributes associative array are described below.

Parameter name

Obligation

Definition/Value

domain_list

Required.

The list of domain names for which to query contact
information. The maximum number of domains that
can be specified in a single request is 100.

active_contacts_only

Optional

Retrieves the currently active contact information for owner, admin, billing and tech, as they are currently set on the domain. This info will be returned regardless of whether there is a pending trade in progress.

  • 0—Returns pending contacts when a trade has been initiated.

  • 1—Returns active contacts.

Response parameters for get_domains_contacts

Standard parameters

  • action = reply
  • object = domain
  • is_success = a Boolean is returned, indicating success or failure of the
    request
  • response_code = response code indicating outcome of the request
  • response_text = message describing the outcome of the request

Attributes

The attributes array includes an array of associative arrays, one for each
domain queried. The associative array for each domain includes the contact
set for that domain.

Parameters within the attributes associative array are described below.

Parameter name

Obligation

Definition/Value

status

Always returned

The status of the contact. Possible values are:

  • active

  • pending_current_registrant - waiting on action from the current owner/registrant of the domain

  • pending_new_registrant - waiting on action from the registrant/owner to whom the domain is pending transfer

Note:

When a pending_current_registrant or pending_new_registrant value is displayed, the contact information included in the response is that which will be displayed in whois once the trade is complete.

Both pending_current_registrant and pending_new_registrant will only ever be returned for gTLDs.

Examples for get_domains_contacts

Example 1

Request

<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
 <header>
  <version>0.9</version>
  </header>
 <body>
  <data_block>
   <dt_assoc>
    <item key="protocol">XCP</item>
    <item key="object">DOMAIN</item>
    <item key="action">GET_DOMAINS_CONTACTS</item>
    <item key="attributes">
     <dt_assoc>
      <item key="active_contacts_only">1</item>
      <item key="domain_list">
       <dt_array>
        <item key="0">weruiofh89q34gh78943g4.com</item>
       </dt_array>
      </item>
     </dt_assoc>
    </item>
   </dt_assoc>
  </data_block>
 </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
 <header>
  <version>0.9</version>
  </header>
 <body>
  <data_block>
   <dt_assoc>
    <item key="protocol">XCP</item>
    <item key="object">DOMAIN</item>
    <item key="response_text">Command successful</item>
    <item key="action">REPLY</item>
    <item key="attributes">
     <dt_assoc>
      <item key="weruiofh89q34gh78943g4.com">
       <dt_assoc>
        <item key="contact_set">
         <dt_assoc>
          <item key="owner">
           <dt_assoc>
            <item key="country">CA</item>
            <item key="address3"></item>
            <item key="org_name">Tucows2</item>
            <item key="status">active</item>
            <item key="phone">+1.4445556666</item>
            <item key="last_name">Rego</item>
            <item key="address2"></item>
            <item key="state">ON</item>
            <item key="email">[email protected]</item>
            <item key="city">Toronto</item>
            <item key="postal_code">A1A1A1</item>
            <item key="fax"></item>
            <item key="address1">96 mowat Ave</item>
            <item key="first_name">Danny22</item>
           </dt_assoc>
          </item>
          <item key="admin">
           <dt_assoc>
            <item key="country">CA</item>
            <item key="address3"></item>
            <item key="org_name">Tucows2</item>
            <item key="status">active</item>
            <item key="phone">+1.4445556666</item>
            <item key="last_name">Rego</item>
            <item key="address2"></item>
            <item key="state">ON</item>
            <item key="email">[email protected]</item>
            <item key="city">Toronto</item>
            <item key="postal_code">A1A1A1</item>
            <item key="fax"></item>
            <item key="address1">96 mowat Ave</item>
            <item key="first_name">Danny22</item>
           </dt_assoc>
          </item>
          <item key="tech">
           <dt_assoc>
            <item key="country">CA</item>
            <item key="address3"></item>
            <item key="org_name">Tucows2</item>
            <item key="status">active</item>
            <item key="phone">+1.4445556666</item>
            <item key="last_name">Rego</item>
            <item key="address2"></item>
            <item key="state">ON</item>
            <item key="email">[email protected]</item>
            <item key="city">Toronto</item>
            <item key="postal_code">A1A1A1</item>
            <item key="fax"></item>
            <item key="address1">96 mowat Ave</item>
            <item key="first_name">Danny22</item>
           </dt_assoc>
          </item>
          <item key="billing">
           <dt_assoc>
            <item key="country">CA</item>
            <item key="address3"></item>
            <item key="org_name">Tucows2</item>
            <item key="status">active</item>
            <item key="phone">+1.4445556666</item>
            <item key="last_name">Rego</item>
            <item key="address2"></item>
            <item key="state">ON</item>
            <item key="email">[email protected]</item>
            <item key="city">Toronto</item>
            <item key="postal_code">A1A1A1</item>
            <item key="fax"></item>
            <item key="address1">96 mowat Ave</item>
            <item key="first_name">Danny22</item>
           </dt_assoc>
          </item>
         </dt_assoc>
        </item>
       </dt_assoc>
      </item>
     </dt_assoc>
    </item>
    <item key="response_code">200</item>
    <item key="is_success">1</item>
   </dt_assoc>
  </data_block>
 </body>
</OPS_envelope>

Example 2

This example shows a get_domains_contacts request and response for active_contacts only.

Note that a request can also be sent for pending_current_registrant, which will return the information that is to be displayed publicly once the trade is complete, and pending_new_registrant, which will return the information of registrant to whom the domain is pending transfer.

Request

<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
 <header>
  <version>0.9</version>
  </header>
 <body>
  <data_block>
   <dt_assoc>
    <item key="protocol">XCP</item>
    <item key="object">DOMAIN</item>
    <item key="action">GET_DOMAINS_CONTACTS</item>
    <item key="attributes">
     <dt_assoc>
      <item key="active_contacts_only">1</item>
      <item key="domain_list">
       <dt_array>
        <item key="0">example.com</item>
       </dt_array>
      </item>
     </dt_assoc>
    </item>
   </dt_assoc>
  </data_block>
 </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
 <header>
  <version>0.9</version>
  </header>
 <body>
  <data_block>
   <dt_assoc>
    <item key="protocol">XCP</item>
    <item key="object">DOMAIN</item>
    <item key="response_text">Command successful</item>
    <item key="action">REPLY</item>
    <item key="attributes">
     <dt_assoc>
      <item key="example.com">
       <dt_assoc>
        <item key="contact_set">
         <dt_assoc>
          <item key="owner">
           <dt_assoc>
            <item key="country">CA</item>
            <item key="address3"></item>
            <item key="org_name">Tucows2</item>
            <item key="status">active</item>
            <item key="phone">+1.4445556666</item>
            <item key="last_name">Rego</item>
            <item key="address2"></item>
            <item key="state">ON</item>
            <item key="email">[email protected]</item>
            <item key="city">Toronto</item>
            <item key="postal_code">A1A1A1</item>
            <item key="fax"></item>
            <item key="address1">96 mowat Ave</item>
            <item key="first_name">Danny22</item>
           </dt_assoc>
          </item>
          <item key="admin">
           <dt_assoc>
            <item key="country">CA</item>
            <item key="address3"></item>
            <item key="org_name">Tucows2</item>
            <item key="status">active</item>
            <item key="phone">+1.4445556666</item>
            <item key="last_name">Rego</item>
            <item key="address2"></item>
            <item key="state">ON</item>
            <item key="email">[email protected]</item>
            <item key="city">Toronto</item>
            <item key="postal_code">A1A1A1</item>
            <item key="fax"></item>
            <item key="address1">96 mowat Ave</item>
            <item key="first_name">Danny22</item>
           </dt_assoc>
          </item>
          <item key="tech">
           <dt_assoc>
            <item key="country">CA</item>
            <item key="address3"></item>
            <item key="org_name">Tucows2</item>
            <item key="status">active</item>
            <item key="phone">+1.4445556666</item>
            <item key="last_name">Rego</item>
            <item key="address2"></item>
            <item key="state">ON</item>
            <item key="email">[email protected]</item>
            <item key="city">Toronto</item>
            <item key="postal_code">A1A1A1</item>
            <item key="fax"></item>
            <item key="address1">96 mowat Ave</item>
            <item key="first_name">Danny22</item>
           </dt_assoc>
          </item>
          <item key="billing">
           <dt_assoc>
            <item key="country">CA</item>
            <item key="address3"></item>
            <item key="org_name">Tucows2</item>
            <item key="status">active</item>
            <item key="phone">+1.4445556666</item>
            <item key="last_name">Rego</item>
            <item key="address2"></item>
            <item key="state">ON</item>
            <item key="email">[email protected]</item>
            <item key="city">Toronto</item>
            <item key="postal_code">A1A1A1</item>
            <item key="fax"></item>
            <item key="address1">96 mowat Ave</item>
            <item key="first_name">Danny22</item>
           </dt_assoc>
          </item>
         </dt_assoc>
        </item>
       </dt_assoc>
      </item>
     </dt_assoc>
    </item>
    <item key="response_code">200</item>
    <item key="is_success">1</item>
   </dt_assoc>
  </data_block>
 </body>
</OPS_envelope>