ProSBC:Restful API SIP Domain Registrar: Difference between revisions
(Created page with "You can create/modify a SIP Domain Registrar in your system with RestFul API using JSON format. The JSON must be in the following format: <pre> { "enabled": true, "*...") |
m (small adjustments) |
||
| (3 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
You can create | 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: | ||
<pre> | <pre> | ||
| Line 27: | Line 27: | ||
POST http://ProSBCIP:12358/configurations/configuration_name/sip_registration_domains/domainname/sip_registration_registrars | 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. | ProSBC will create a new SIP Domain Registrar from the name in the JSON file. | ||
| Line 37: | Line 38: | ||
If the new SIP Domain Registrar is created successfully, | If the new SIP Domain Registrar is created successfully, the following message is returned in the Postman Tool | ||
[[Image:RestFul_sip_domain_registrar_Post_Response.png|800px| ]] | [[Image:RestFul_sip_domain_registrar_Post_Response.png|800px| ]] | ||
== 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 | |||
[[Image:SIP_Domain_registrar_Put_Send.png|800px| ]] | |||
If the update is successful, the following message is returned in the Postman Tool | |||
[[Image:SIP_Domain_registrar_Put_Response.png|800px| ]] | |||
You can get more information about how to use RestFul API and Postman Tool from the following link [[Northbound_interface:RESTful]] | |||
Latest revision as of 12:59, 13 February 2023
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:
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:
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:
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