Documentation

Support

Vivox Unreal SDK

Vivox Unreal SDK

Login API

Reference the Login API for user authentication.
Read time 1 minuteLast updated 2 days ago
The game server uses 
/api2/viv_signin.php
to sign in to the Vivox service and obtain an 
auth_token
.
  • A successful 
    viv_signin.php
    call returns an 
    auth_token
    in the response.
  • The 
    auth_token
    authenticates subsequence web requests.
Use the following parameters to perform a sign in action:
  • userid - The Vivox username of the user to sign in.
  • pwd - The password associated with the userid.
The following example displays the URL structure to use when you call 
viv_signin.php
: 
https://mt1s.www.vivox.com/api2/viv_signin.php?userid=Vivox-RuneRun-dev-Admin&pwd=aKDnh2FIyHeyzwBd
 The following code displays the response for this example. 
<response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.vivox.com" xsi:schemaLocation="/xsd/response.xsd">    <level0>        <status>OK</status>        <body>            <status>Ok</status>            <sip_qval>1</sip_qval>            <loginname>Vivox-RuneRun-dev-Admin</loginname>            <displayname/>            <account_id>161</account_id>            <auth_token>                Vivox-RuneRun-dev-Admin:1540215742:3b0182741a3ebd92487a640d9e16d50e:10.5.255.168            </auth_token>            <sip_acct>sip:Vivox-RuneRun-dev-Admin@mt1s.vivox.com</sip_acct>            <sip_uri>sip:Vivox-RuneRun-dev-Admin@mt1s.vivox.com</sip_uri>            <sip_displayname/>        </body>    </level0></response>