Rate this page:

GetSipRegistrationsRequest

Props

applicationId
Optional
Copy URL
applicationId: 

number

|

number[]

|

any

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

applicationName
Optional
Copy URL
applicationName: 

string

|

string[]

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

count
Optional
Copy URL
count: 

number

The maximum returning record count

deactivated
Optional
Copy URL
deactivated: 

boolean

Whether to show the frozen SIP registrations only

inProgress
Optional
Copy URL
inProgress: 

boolean

Whether SIP registration is still in progress

isBoundToApplication
Optional
Copy URL
isBoundToApplication: 

boolean

Whether SIP registration bound to an application

isPersistent
Optional
Copy URL
isPersistent: 

boolean

Whether the SIP registration is persistent to filter

offset
Optional
Copy URL
offset: 

number

The first N records are skipped in the output

proxy
Optional
Copy URL
proxy: 

string

|

string[]

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

ruleId
Optional
Copy URL
ruleId: 

number

|

number[]

|

any

The rule ID list separated by semicolons (;) to filter. Required unless rule_name is provided.

ruleName
Optional
Copy URL
ruleName: 

string

|

string[]

The rule name list separated by semicolons (;) to filter. Required unless rule_id is provided.

sipRegistrationId
Optional
Copy URL
sipRegistrationId: 

number

The SIP registration ID

sipUsername
Optional
Copy URL
sipUsername: 

string

The SIP user name to filter

statusCode
Optional
Copy URL
statusCode: 

string

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
Optional
Copy URL
successful: 

boolean

Whether to show the successful SIP registrations only

userId
Optional
Copy URL
userId: 

number

|

number[]

|

any

The user ID list separated by semicolons (;) to filter. Required unless user_name is provided.

userName
Optional
Copy URL
userName: 

string

|

string[]

Rate this page: