1. References
  2. Management API
  3. SIPRegistration
Rate this page:

SIPRegistration

Methods

CreateSipRegistration

Copy URL

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.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Accountant
CreateSipRegistration example
Copy

CreateSipRegistration example

Create SIP registration.

Parameters

  • sip_username:

    string

    The user name

  • proxy:

    string

    The SIP proxy

  • auth_user:

    string

    Optional

    The SIP authentications user

  • outbound_proxy:

    string

    Optional

    The outgoing SIP proxy

  • password:

    string

    Optional

    The SIP password

  • is_persistent:

    boolean

    Optional
    Defaults on:  true

    Whether SIP registration is persistent. Set false to activate it only on the user login

  • application_id:

    number

    Optional

    The application ID which a new SIP registration is to be bound to. Can be used instead of the application_name parameter

  • application_name:

    string

    Optional

    The application name which a new SIP registration is to be bound to. Can be used instead of the application_id parameter

  • rule_id:

    number

    Optional

    The rule ID which a new SIP registration is to be bound to. Can be used instead of the rule_name parameter

  • rule_name:

    string

    Optional

    The rule name which a new SIP registration is to be bound to. Can be used instead of the rule_id parameter

  • user_id:

    number

    Optional

    The user ID which a new SIP registration is to be bound to. Can be used instead of the user_name parameter

  • user_name:

    string

    Optional

    The user name which a new SIP registration is to be bound to. Can be used instead of the user_id parameter

Returns

  • result:

    number

    1

  • sip_registration_id:

    number

    The sip registration id

  • account_info:

    ShortAccountInfoType

    The current account state

UpdateSipRegistration

Copy URL

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).

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
UpdateSipRegistration example
Copy

UpdateSipRegistration example

Update SIP registration with id 1.

Parameters

  • sip_registration_id:

    number

    The registration ID

  • sip_username:

    string

    Optional

    The user name

  • proxy:

    string

    Optional

    The SIP proxy

  • auth_user:

    string

    Optional

    The SIP authentications user

  • outbound_proxy:

    string

    Optional

    The outgoing SIP proxy

  • password:

    string

    Optional

    The SIP password

  • application_id:

    number

    Optional

    The application ID which the SIP registration is to be bound to. Can be used instead of the application_name parameter

  • application_name:

    string

    Optional

    The application name which the SIP registration is to be bound to. Can be used instead of the application_id parameter

  • rule_id:

    number

    Optional

    The rule ID which the SIP registration is to be bound to. Can be used instead of the rule_name parameter

  • rule_name:

    string

    Optional

    The rule name which the SIP registration is to be bound to. Can be used instead of the rule_id parameter

  • user_id:

    number

    Optional

    The user ID which the SIP registration is to be bound to. Can be used instead of the user_name parameter

  • user_name:

    string

    Optional

    The user name which the SIP registration is to be bound to. Can be used instead of the user_id parameter

Returns

  • result:

    number

    1

BindSipRegistration

Copy URL

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).

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
BindSipRegistration example
Copy

BindSipRegistration example

Bind SIP registration with id 1 to application with id 123.

Parameters

  • sip_registration_id:

    number

    Optional

    The registration ID

  • application_id:

    number

    Optional

    The application ID which the SIP registration is to be bound to. Can be used instead of the application_name parameter

  • application_name:

    string

    Optional

    The application name which the SIP registration is to be bound to. Can be used instead of the application_id parameter

  • rule_id:

    number

    Optional

    The rule ID which the SIP registration is to be bound to. Can be used instead of the rule_name parameter

  • rule_name:

    string

    Optional

    The rule name which the SIP registration is to be bound to. Can be used instead of the rule_id parameter

  • user_id:

    number

    Optional

    The user ID which the SIP registration is to be bound to. Can be used instead of the user_name parameter

  • user_name:

    string

    Optional

    The user name which the SIP registration is to be bound to. Can be used instead of the user_id parameter

  • bind:

    boolean

    Optional
    Defaults on:  true

    Whether to bind or unbind (set true or false respectively)

Returns

  • result:

    number

    1

DeleteSipRegistration

Copy URL

Delete SIP registration.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
DeleteSipRegistration example
Copy

DeleteSipRegistration example

Delete SIP registration with id 1.

Parameters

  • sip_registration_id:

    number

    The registration ID

Returns

  • result:

    number

    1

GetSipRegistrations

Copy URL

Get active SIP registrations.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
Supervisor
Accountant
Support
GetSipRegistrations example
Copy

GetSipRegistrations example

Get all active sip registrations.

Parameters

  • sip_registration_id:

    number

    Optional

    The SIP registration ID

  • sip_username:

    string

    Optional

    The SIP user name to filter

  • deactivated:

    boolean

    Optional

    Whether to show the frozen SIP registrations only

  • successful:

    boolean

    Optional

    Whether to show the successful SIP registrations only

  • is_persistent:

    boolean

    Optional

    Whether the SIP registration is persistent to filter

  • application_id:

    intlist

    Optional

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

  • application_name:

    stringlist

    Optional

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

  • is_bound_to_application:

    boolean

    Optional

    Whether SIP registration bound to an application

  • 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

  • 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

  • proxy:

    stringlist

    Optional

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

  • in_progress:

    boolean

    Optional

    Whether SIP registration is still in progress

  • status_code:

    string

    Optional

    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

  • count:

    number

    Optional

    The max returning record count

  • offset:

    number

    Optional

    The first N records are skipped in the output

Returns