Interface X6

Interface X6. Sending message to random WM-identifier via internal mail.

This interface is available only to the registered clients. The option can be enabled at the Web Merchant Interface service settings page in the "additional parameters" section. The Keeper that signs requests should have Personal passport.

<w3s.request>
    <reqn></reqn>
    <wmid></wmid>
    <sign></sign>
    <message>
        <receiverwmid></receiverwmid>
        <msgtext></msgtext>
        <onlyauth></onlyauth>
    </message>
</w3s.request>
  • request parameters:
name purpose comments
reqn request number an integer without delimiter, max number of digits - 15; the value must always be greater than the number of previous request!!!
wmid WMID of the user who signed the request used only when authorizing WM Keeper WinPro keys
sign request signature - is formed using the following parameters: receiverwmid+reqn+msgtext used only when authorizing WM Keeper WinPro keys
message parameters of sent message
message\receiverwmid WM identifier of message recepient 12 digits
message\msgtext message text random string from 1 to 1024 characters; white spaces in the beginning or end are not allowed; use '\n'(\x10, chr(10)) for string feed
message\onlyauth Consider recipient authorization If 0 - then messages are sent without considering recipient's permission for this action. If 1 - then messages are sent only if the recipient permission (otherwise error code 35 is returned). Users can forbid to send them messages in two cases. The first case is when the recipient forbade to send him messages for this specific correspondent. The second case is when the reciient forbade to send him messages for unauthorized correspondents, and the sender is unauthorized.

In case there are tags in message text or message subject then you must include the contents of the corresponding request elements into the CDATA section: &lt;![CDATA[your_text]]>.

  • response format:
<w3s.response>
    <reqn></reqn>
    <retval></retval>
    <retdesc></retdesc>
    <message id="n1">
        <receiverwmid></receiverwmid>
        <msgtext></msgtext>
        <datecrt></datecrt>
    </message>
</w3s.response>
  • response parameters:
name purpose comments
reqn request number
retval request processing code 0 - request successful
retdesc description of request processing code
message parameters of sent message id attribute - unique message number in WebMoney registration system
message\receiverwmid WM identifier of message receiver 12 digits
message\msgtext message text
message\datecrt date and time of message delivery format YYYYMMDD HH:MM:SS
  • specific interface errors (retval):
code description
-2 invalid value in message\receiverwmid field
-4 invalid value in w3s.request\wmid field
-12 signature is invalid
6,7 user is not found
35 the recipient does not receive message from unauthorized contacts
102 the condition of constant increase of parameter value is not met w3s.request/reqn
110 no access to interface

See also: XML-interfaces