SIPRegistration
Methods
BindSipRegistration
Bind the SIP registration to the application/user or unbind the SIP registration from the application/user. You should specify the application_id or application_name if you specify the rule_name or user_id, or user_name. You should specify the sip_registration_id if you set bind=true. You can bind only one SIP registration to the user (the previous SIP registration is automatically unbound).
To call this method, make sure your service account has one of the following roles:
Parameters
application_id:
number
OptionalThe application ID which the SIP registration is to be bound to. Can be used instead of the application_name parameter
application_name:
string
OptionalThe application name which the SIP registration is to be bound to. Can be used instead of the application_id parameter
bind:
boolean
OptionalDefaults on: trueWhether to bind or unbind (set true or false respectively)
rule_id:
number
OptionalThe rule ID which the SIP registration is to be bound to. Can be used instead of the rule_name parameter
rule_name:
string
OptionalThe rule name which the SIP registration is to be bound to. Can be used instead of the rule_id parameter
sip_registration_id:
number
OptionalThe registration ID
user_id:
number
OptionalThe user ID which the SIP registration is to be bound to. Can be used instead of the user_name parameter
user_name:
string
OptionalThe user name which the SIP registration is to be bound to. Can be used instead of the user_id parameter
Returns
result:
number
1
CreateSipRegistration
Create a new SIP registration. You should specify the application_id or application_name if you specify the rule_name or user_id, or user_name. You should set is_persistent=true if you specify the user_id or user_name. You can bind only one SIP registration to the user (the previous SIP registration are automatically unbound).
Please note that when you create a SIP registration, we reserve the subscription fee and taxes for the upcoming month. Read more in the Billing page.
To call this method, make sure your service account has one of the following roles:
Parameters
application_id:
number
OptionalThe application ID which a new SIP registration is to be bound to. Can be used instead of the application_name parameter
application_name:
string
OptionalThe application name which a new SIP registration is to be bound to. Can be used instead of the application_id parameter
auth_user:
string
OptionalThe SIP authentications user
is_persistent:
boolean
OptionalDefaults on: trueWhether SIP registration is persistent. Set false to activate it only on the user login
outbound_proxy:
string
OptionalThe outgoing SIP proxy
password:
string
OptionalThe SIP password
proxy:
string
The SIP proxy
rule_id:
number
OptionalThe rule ID which a new SIP registration is to be bound to. Can be used instead of the rule_name parameter
rule_name:
string
OptionalThe rule name which a new SIP registration is to be bound to. Can be used instead of the rule_id parameter
sip_username:
string
The user name
user_id:
number
OptionalThe user ID which a new SIP registration is to be bound to. Can be used instead of the user_name parameter
user_name:
string
OptionalThe user name which a new SIP registration is to be bound to. Can be used instead of the user_id parameter
Returns
account_info:
The current account state
result:
number
1
sip_registration_id:
number
The sip registration id
DeleteSipRegistration
Delete SIP registration.
To call this method, make sure your service account has one of the following roles:
Parameters
sip_registration_id:
number
The registration ID
Returns
result:
number
1
GetSipRegistrations
Get active SIP registrations.
To call this method, make sure your service account has one of the following roles:
Parameters
application_id:
intlist
OptionalThe application ID list separated by semicolons (;) to filter. Can be used instead of application_name
application_name:
stringlist
OptionalThe application name list separated by semicolons (;) to filter. Can be used instead of application_id
count:
number
OptionalThe max returning record count
deactivated:
boolean
OptionalWhether to show the frozen SIP registrations only
in_progress:
boolean
OptionalWhether SIP registration is still in progress
is_bound_to_application:
boolean
OptionalWhether SIP registration bound to an application
is_persistent:
boolean
OptionalWhether the SIP registration is persistent to filter
offset:
number
OptionalThe first N records are skipped in the output
proxy:
stringlist
OptionalThe list of proxy servers to use, divided by semicolon (;)
rule_id:
intlist
The rule ID list separated by semicolons (;) to filter. Can be used instead of rule_name
rule_name:
stringlist
The rule name list separated by semicolons (;) to filter. Can be used instead of rule_id
sip_registration_id:
number
OptionalThe SIP registration ID
sip_username:
string
OptionalThe SIP user name to filter
status_code:
string
OptionalThe 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:
boolean
OptionalWhether to show the successful SIP registrations only
user_id:
intlist
The user ID list separated by semicolons (;) to filter. Can be used instead of user_name
user_name:
stringlist
The user name list separated by semicolons (;) to filter. Can be used instead of user_id
Returns
count:
number
Count rows
result:
Active SIP registrations
UpdateSipRegistration
Update SIP registration. You should specify the application_id or application_name if you specify the rule_name or user_id, or user_name. You can bind only one SIP registration to the user (the previous SIP registration is automatically unbound).
To call this method, make sure your service account has one of the following roles:
Parameters
application_id:
number
OptionalThe application ID which the SIP registration is to be bound to. Can be used instead of the application_name parameter
application_name:
string
OptionalThe application name which the SIP registration is to be bound to. Can be used instead of the application_id parameter
auth_user:
string
OptionalThe SIP authentications user
outbound_proxy:
string
OptionalThe outgoing SIP proxy
password:
string
OptionalThe SIP password
proxy:
string
OptionalThe SIP proxy
rule_id:
number
OptionalThe rule ID which the SIP registration is to be bound to. Can be used instead of the rule_name parameter
rule_name:
string
OptionalThe rule name which the SIP registration is to be bound to. Can be used instead of the rule_id parameter
sip_registration_id:
number
The registration ID
sip_username:
string
OptionalThe user name
user_id:
number
OptionalThe user ID which the SIP registration is to be bound to. Can be used instead of the user_name parameter
user_name:
string
OptionalThe user name which the SIP registration is to be bound to. Can be used instead of the user_id parameter
Returns
result:
number
1