Skip to content
FlySIPFlySIP Docs

Get the SIP registration of an account

getRegistrationStatus tells you whether a SIP device is registered for an account and returns the details of the registration. Use it to check that a customer’s phone or PBX is online before you troubleshoot calls.

The method supports trusted mode with i_customer, the customer that owns the account.

Parameters

Section titled “Parameters”
Name Type Required Description
i_account int yes ID of the account

Returns

Section titled “Returns”
Name Type Description
result string OK: the account is registered
user_agent string User-Agent header of the registered device
contact string Contact header of the registration: where calls to the account are sent
expires string When the registration expires, in UTC, in the format %H:%M:%S.000 GMT %a %b %d %Y, for example 09:57:29.000 GMT Wed Nov 18 2026. This is a string, not a dateTime

Example

Section titled “Example”
request
call("getRegistrationStatus", {"i_account": 3092})
response
{
    "result": "OK",
    "user_agent": "Yealink SIP-T46U 108.86.0.20",
    "contact": "sip:1001@198.51.100.24:5060",
    "expires": "09:57:29.000 GMT Wed Nov 18 2026",
}

Errors

Section titled “Errors”
faultCode faultString Cause
403 Account is not registered No device is registered for the account. This is the normal answer for an offline account
Section titled “Related”