Managed by the FaxBack Support Team

ADD_USER

NET SatisFAXtion CAS XML API Function
Creates a new user account, where USER_NAME is the user name to create. USER_NAME must be unique and should not be the same as a DID number or an email address because it could cause unexpected routing behavior.
Warning: The USER_NAME value cannot be an empty string. The application is responsible for validating the USER_NAME is not null. While the XML response will return an error, an empty user name will be created that cannot be deleted from the NET SatisFAXtion address book.
A new UG_UNIQUE_ID will be returned on a successful response. This is the unique id of the created user and can be used for future function calls.
Always be sure to add <GROUP_NAME>All Users</GROUP_NAME> so that the created user is visible using the Administration program.
Typically USER_T30_ROUTING, USER_DTMF_ROUTING and USER_CSID_ROUTING are all set to the same DID number. Note that T.30 (subaddress) and CSID routing are disabled by default.
When creating an email-enabled user (by specifying the USER_EMAIL_ADDRESS parameter), also be sure to call ADD_USER_ALIAS_FUNCTION otherwise the user will not be allowed to send faxes by email.

Request Parameters

REGISTERED_NAME (Required)
REGISTERED_PASSWORD (Required)
USER_NAME (Required)
USER_DESCRIPTION
USER_EMAIL_ADDRESS
USER_FULLNAME
USER_TYPE
PB_FIRST_NAME
PB_MIDDLE_NAME
PB_LAST_NAME
UG_USER_AUTOFORWARD
UG_USER_AUTOFORWARD_ON
UG_AUTOFORWARD
USER_CSID_ROUTING
USER_DTMF_ROUTING
USER_T30_ROUTING
USER_LINE_ROUTING
USER_BILLING_CODE
USER_MESSAGE_PREVIEW
USER_SHORT_NAME
USER_PASSWORD

Response Parameters

ADD_USER_RESULT
UG_UNIQUE_ID
STATUS
STATUS_NUM

Examples

<!-- Request -->
<?xml version="1.0" encoding="UTF-8"?>
<CAS>
    <DOMAIN_NAME>\\NETSATISFAXTION\NSTESTER</DOMAIN_NAME>
    <REMOTE_LOGON_NAME>NSTESTER</REMOTE_LOGON_NAME>
    <PROTOCOL>2</PROTOCOL>
    <TAGLIST>
        <ADD_USER/>
        <USER_NAME>Al Armstrong</USER_NAME>
        <USER_DESCRIPTION>;csid=5550123;tsid=5550123;ani=5550123;rcvfmt=pdf;ntf=*</USER_DESCRIPTION>
        <USER_EMAIL_ADDRESS>SMTPPost!example.com!aarmstrong</USER_EMAIL_ADDRESS>
        <USER_FULLNAME>Al Armstrong</USER_FULLNAME>
        <USER_T30_ROUTING>5339</USER_T30_ROUTING>
        <USER_DTMF_ROUTING>5339</USER_DTMF_ROUTING>
        <USER_CSID_ROUTING>5339</USER_CSID_ROUTING>
        <GROUP_NAME>All Users</GROUP_NAME>
        <!-- Password must be encrypted -->
        <USER_PASSWORD>$#43RPu SB1 mYKxgVE4#2!TC2!n]Ly</USER_PASSWORD>
        <REGISTERED_NAME>Supervisor</REGISTERED_NAME>
        <REGISTERED_PASSWORD>$#43RPu SB1 mYKxgVE4#2!TC2!n]Ly</REGISTERED_PASSWORD>
    </TAGLIST>
    <!-- To enable routing, you must set the user alias -->
    <TAGLIST>
        <ADD_USER_ALIAS_FUNCTION/>
        <REGISTERED_NAME>Supervisor</REGISTERED_NAME>
        <REGISTERED_PASSWORD>$#43RPu SB1 mYKxgVE4#2!TC2!n]Ly</REGISTERED_PASSWORD>
        <USER_NAME>Al Armstrong</USER_NAME>
        <USER_ALIAS_NAME>SMTPPost!example.com!aarmstrong</USER_ALIAS_NAME>
    </TAGLIST>
</CAS>
 
<!-- Response -->
<?xml version="1.0" encoding="UTF-8"?>
<CAS>
    <TAGLIST>
        <ADD_USER_RESULT/>
        <STATUS_NUM>0</STATUS_NUM>
        <STATUS>No Errors</STATUS>
        <UG_UNIQUE_ID>14</UG_UNIQUE_ID>
        <NO_ACKNOWLEDGMENT>1</NO_ACKNOWLEDGMENT>
    </TAGLIST>
    <TAGLIST>
        <ADD_USER_ALIAS_RESULT/>
        <STATUS_NUM>0</STATUS_NUM>
        <STATUS>No Errors</STATUS>
        <NO_ACKNOWLEDGMENT>1</NO_ACKNOWLEDGMENT>
    </TAGLIST>
    <STATUS_NUM>0</STATUS_NUM>
    <STATUS_EXTENDED_NUM>0</STATUS_EXTENDED_NUM>
    <STATUS/>
</CAS>

Copyright © FaxBack, Inc.