ProSBC:Restful API SIP Domain Registrar

You can create and modify a SIP Domain Registrar in your system with the RestFul API using JSON format. The JSON must be in the following format:

{
    "enabled": true,
    "***meta***": {
        "version": "3.1.137",
        "src_path": ""
    },
    "name": "3CX_REGISTRAR",
    "nap": "3CX",
    "position": 1
}

Important parameters in the JSON file

• name

• nap

• position: If you need to add more than one SIP registrar you need to use position to give priority.

Adding a new SIP Domain Registrar

You can add a new SIP Domain Registrar with the POST command:

POST http://ProSBCIP:12358/configurations/configuration_name/sip_registration_domains/domainname/sip_registration_registrars

ProSBC will create a new SIP Domain Registrar from the name in the JSON file.

Example: We use the Postman tool in this example and the URL is:

http://192.168.1.25:12358/configurations/config_2/sip_registration_domains/TEST_DOMAIN/sip_registration_registrars

If the new SIP Domain Registrar is created successfully, the following message is returned in the Postman Tool

Modifiying a SIP Domain Registrar

You can modify the existing SIP Domain Registrar with the PUT command:

PUT http://ProSBCIP:12358/configurations/configurationname/sip_registration_domains/sip_domain_name/sip_registration_registrars/registrar_name

Example: We use the Postman tool in this example and the URL is

192.168.1.25:12358/configurations/config_2/sip_registration_domains/TEST_DOMAIN/sip_registration_registrars/3CX_REGISTRAR and disable it

If the update is successful, the following message is returned in the Postman Tool

You can get more information about how to use RestFul API and Postman Tool from the following link Northbound_interface:RESTful