API: OpenSRS

OpenSRS API Guide: Domains and SSL

Welcome to the OpenSRS API guide. Here you will find comprehensive documentation regarding our domain and SSL services. We hope this guide will help you start working with OpenSRS as quickly as possible. If you have any questions or concerns, please do not hesitate to contact help@opensrs.com

Get Started

resend_trade_approval_notice

Resends the notice of a trade approval.

Request Parameters for resend_trade_approval_notice

Standard parameters:

  • action = resend_trade_approval_notice
  • object = domain
  • protocol = XCP

Attributes

Parameters within the attributes associative array are described below.

Parameter name
Obligation
Definition/Value

registrant_type

Required.

The status type of the registrant.

Possible values are:

  • new
  • current

send_type

Required

The preferred method of delivery for the approval notice.

Possible values are:

  • SMS
  • Email

Note: send_type = SMS is an option only when registrant_type = current.

sms_phone_number

Optional.

Note: If send_type=SMS and no value for sms_phone_number is supplied, the SMS notification will be sent to the current registrant phone number.

If an updated phone number is supplied, the SMS will be directed to the updated number.

The phone number to which the SMS message will be sent.

Response Parameters for resend_trade_approval_notice

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

Parameters within the attributes associative array are described below.

Examples for resend_trade_approval_notice

When send_type = SMS

Request

<?xml version="1.0"?>
<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">RESEND_TRADE_APPROVAL_NOTICE</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="registrant_type">current</item>
                        <item key="domain">tucows-d6ad7a0fc501d8.com</item>
                        <item key="send_type">sms</item>
                        <item key="sms_phone_number">+1.2602180057</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">SMS message successfully sent to +1.2602180057</item>
                <item key="action">REPLY</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

When send_type = Email

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">RESEND_TRADE_APPROVAL_NOTICE</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="registrant_type">new</item>
                        <item key="domain">gfe7892gf2933e2f.com</item>
                        <item key="send_type">email</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">Approval notification re-sent via EMAIL for the new registrant</item>
                <item key="action">REPLY</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

resend_trade_approval_notice


Resends the notice of a trade approval.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.