Rate this page:

GetSipRegistrationsRequest

Props

applicationId

Copy URL
applicationId: 

any

|

number

|

number[]

The application ID list separated by semicolons (;) to filter. Can be used instead of application_name

applicationName

Copy URL
applicationName: 

string

|

string[]

The application name list separated by semicolons (;) to filter. Can be used instead of application_id

count

Copy URL
count: 

number

|

undefined

The max returning record count

deactivated

Copy URL
deactivated: 

false

|

undefined

|

true

Whether to show the frozen SIP registrations only

inProgress

Copy URL
inProgress: 

false

|

undefined

|

true

Whether SIP registration is still in progress

isBoundToApplication

Copy URL
isBoundToApplication: 

false

|

undefined

|

true

Whether SIP registration bound to an application

isPersistent

Copy URL
isPersistent: 

false

|

undefined

|

true

Whether the SIP registration is persistent to filter

offset

Copy URL
offset: 

number

|

undefined

The first N records are skipped in the output

proxy

Copy URL
proxy: 

string

|

string[]

The list of proxy servers to use, divided by semicolon (;)

ruleId

Copy URL
ruleId: 

any

|

number

|

number[]

The rule ID list separated by semicolons (;) to filter. Can be used instead of rule_name

ruleName

Copy URL
ruleName: 

string

|

string[]

The rule name list separated by semicolons (;) to filter. Can be used instead of rule_id

sipRegistrationId

Copy URL
sipRegistrationId: 

number

|

undefined

The SIP registration ID

sipUsername

Copy URL
sipUsername: 

string

|

undefined

The SIP user name to filter

statusCode

Copy URL
statusCode: 

string

|

undefined

The list of SIP response codes. The code1:code2 means a range from code1 to code2 including; the code1;code2 meanse either code1 or code2. You can combine ranges, e.g., code1;code2:code3

successful

Copy URL
successful: 

false

|

undefined

|

true

Whether to show the successful SIP registrations only

userId

Copy URL
userId: 

any

|

number

|

number[]

The user ID list separated by semicolons (;) to filter. Can be used instead of user_name

userName

Copy URL
userName: 

string

|

string[]

The user name list separated by semicolons (;) to filter. Can be used instead of user_id