ACCOUNT.SIP.STATUS - API REQUEST

ACCOUNT.SIP.STATUS - get current SIP registration status.

Description

ACCOUNT.SIP.STATUS API Action is used to get the latest SIP registration status (UA, IP address from where SIP device is registered, Anveo POP and when SIP device was registered).

Arguments

ACCOUNT_NUMBER
Optional. Only needed when getting SIP status for a sub-account. ACCOUNT_NUMBER can also be set to ALL if SIP status is needed for all sub-accounts

Example:
<PARAMETER NAME="ACCOUNT_NUMBER">23434323423</PARAMETER>

Response

SIPSTATUS XML Node has a set of XML objects (Nodes) which contain SIP registration details.
ACCOUNT_NUMBER [string] - account number
IP [string] - IP address and port number from which SIP device is registered.
REGISTRATIONEXPIRESDATETIME [dd/mm/yyyy hh24:mi:ss in UTC timezone] - Date and time SIP Registration expires.
REGISTRATIONDATETIME [dd/mm/yyyy hh24:mi:ss in UTC timezone] - Date and Time when SIP device was registered
UA [string] - User Agent for SIP device
POP [string] - Anveo POP server SIP Device is registered with.
STATUS [string] - Can contain either ONLINE or OFFLINE. ONLINE status indicates that SIP Registration is active. OFFLINE means that SIP registration has expired.

API Request Example

<?xml version="1.0" standalone="no" ?>
<REQUEST>
	<USERTOKEN>
		<USERKEY>df141891e2e883904b0b294dc5bq79c1c1c13f6d</USERKEY>
	</USERTOKEN>
	<ACTION NAME="ACCOUNT.SIP.STATUS">
		<PARAMETER NAME="ACCOUNT_NUMBER">0123456789</PARAMETER>
	</ACTION>
</REQUEST>

Response Example

<?xml version="1.0" standalone="no" ?>
<RESPONSE>
	<RESULT>SUCCESS</RESULT>
	<SIPSTATUS>
		<IP>58.60.12.36:5060</IP>
		<REGISTRATIONDATETIME>7/10/2012 3:25:11 AM</REGISTRATIONDATETIME>
		<REGISTRATIONEXPIRESDATETIME>7/10/2012 3:40:07 AM</REGISTRATIONEXPIRESDATETIME>
		<UA>SIPPER for PhonerLite</UA>
		<POP>sip.anveo.com</POP>
		<STATUS>ONLINE</STATUS>
	</SIPSTATUS>
</RESPONSE>