Skip to content

Poll Request

Purpose

Allow registrars to discover and retrieve queued messages (EPP responses) from the API Server.

These messages also include notifications sent by the API Server, such as Low Credit alert.

If the message queue is not empty, a successful response to a <poll> command should return the first message from the message queue.

Each response returned from the server includes a server-unique message identifier that should be provided to acknowledge receipt of the message, and a counter that indicates the number of messages in the queue.

After a message has been received by the client, the client should respond to the message with an explicit acknowledgement to confirm that the message has been received.

The server should dequeue the message and decrement the queue counter after receiving acknowledgement from the client, enabling retrieval of the next.

Authority

A Poll Request can be submitted by the AR, concerning its own Requests.

Result

Request is processed immediately.

Attributes

When 'op' is set to 'req' – Server will respond the number of queued messages, unique message identifier with its detailed EPP response.

When 'op' is set to 'ack' – the unique message identifier must be applied as well. If exists, server dequeue the message and decrement the queue counter.

Code Example

<?xml version="1.0" encoding="UTF-8"?>
<epp>
    <command>
        <poll op="req"/>
        <clTRID>AB-1971</clTRID>
    </command>
</epp>

Legend

  • <poll op="req"/>: Retrieves the first message from the server message queue.
  • <clTRID>: AR's transaction identifier

Tag Occurance Table

Tag Occurrences
(MIN-MAX)
Size + Remarks
<epp> 1
<command> 1
<poll op="req" /> 1
<clTRID> 1 token: 3-64

Poll Acknowledgement

<?xml version="1.0" encoding="UTF-8"?>
<epp>
    <command>
        <poll op="ack" msgID="1111"/>
        <clTRID>AB-1971</clTRID>
    </command>
</epp>

Poll Acknowledgement Legend

  • <poll op="ack" msgID="1111"/>: msgID - the unique message identifier received by Poll Request
  • <clTRID>: AR's transaction identifier

Tag Occurance Table - Poll Acknowledgement

Tag Occurrences
(MIN-MAX)
Size + Remarks
<epp> 1
<command> 1
<poll op="ack" msgID="[number"] /> 1 unique message identifier
<clTRID> 1 token: 3-64

Response Example

<?xml version="1.0" encoding="UTF-8"?>
<epp>
    <response>
        <result>
            <code>1301</code>
            <msg>Command completed successfully; ack to dequeue</msg>
        </result>
        <msgq count="1" id="19707">
            <qdate>2020-03-31T12:24:01.000Z</qdate>
            <msg code="1000">Command completed successfully</msg>
        </msgq>
        <resData>
            ...
        </resData >
        <trID>
            <clTRID>AB-1971</clTRID>
            <svTRID>ISOCIL-AB755 20060207151800</svTRID>
        </trID>
    </response>
</epp>

Response Legend

  • <result>: Indicates the processing status of the request.
  • <msgq>: Contains the number of queued messages (count) and the unique message identifier (id).
    • <qdate>: Message recording date
    • <msg>: Response code of queued message response code
  • <resData>: The data sent in response specific to the queued message
  • <trID>: Unique transaction identifier.
    • <clTRID>: AR's transaction identifier.
    • <svTRID>: API Server transaction identifier.

<resData> block in Server's response to Poll Acknowledgment

<?xml version="1.0" encoding="UTF-8"?>
<epp>
    <response>
        <result>
            <code>1000</code>
            <msg>Command completed successfully </msg>
        </result>
        <msgq count="0" id="19707">
            <qdate>2020-03-31T12:24:01.000Z</qdate>
            <msg code="1000">Command completed successfully</msg>
        </msgq>
        <trID>
            <clTRID>AB-1971</clTRID>
            <svTRID>ISOCIL-AB755 20060207151800</svTRID>
        </trID>
    </response>
</epp>

Poll Acknowledgment Response Legend

  • <result>: Indicates the processing status of the request.
  • <msgq>: Contains the number of queued messages (count) and the unique message identifier (id).
    • <qdate>: Message recording date
    • <msg>: Response code of queued message response code
  • <trID>: Unique transaction identifier.
    • <clTRID>: AR's transaction identifier.
    • <svTRID>: API Server transaction identifier.