ProSBC:Restful API SIP Domain - Revision history

Allyntree: Minor. Just changed to active voice. Nothing at all major

2024-08-16T18:18:50Z

Minor. Just changed to active voice. Nothing at all major

← Older revision		Revision as of 13:18, 16 August 2024
Line 1:		Line 1:
	~~You can create~~ and modify a SIP Domain in your system with RestFul API using JSON in the following format:		Create and modify a SIP Domain in your system with RestFul API using JSON in the following format:

	<pre>		<pre>
Line 61:		Line 61:
	* [[Parameter: Forwarding Mode\|forwarding_mode]]		* [[Parameter: Forwarding Mode\|forwarding_mode]]

	==~~Adding~~ a new SIP Domain==		==Add a new SIP Domain==

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

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


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

	Example: Using the Postman tool, the URL is:		Example: Using the Postman tool, the URL is:
Line 82:		Line 82:
	[[Image:RestFul_sip_domain_Post_Response.png\|800px\| ]]		[[Image:RestFul_sip_domain_Post_Response.png\|800px\| ]]

	==~~Modifiying~~ a SIP Domain==		==Modify a SIP Domain==

	~~You can modify~~ the existing SIP Domain with the PUT command:		Modify the existing SIP Domain with the PUT command:

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

Serdar Civici at 20:02, 15 August 2024

2024-08-15T20:02:56Z

← Older revision		Revision as of 15:02, 15 August 2024
Line 65:		Line 65:
	You can add a new SIP Domain with the POST command:		You can add a new SIP Domain with the POST command:

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

Abaum at 15:25, 3 March 2023

2023-03-03T15:25:41Z

← Older revision		Revision as of 10:25, 3 March 2023
Line 1:		Line 1:
	You can create and modify a SIP Domain in your system with RestFul API using JSON ~~format. The JSON must be~~ in the following format:		You can create and modify a SIP Domain in your system with RestFul API using JSON in the following format:

	<pre>		<pre>
Line 70:		Line 70:
	ProSBC will create a new SIP Domain from the name in the JSON file.		ProSBC will create a new SIP Domain from the name in the JSON file.

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

	http://192.168.1.25:12358/configurations/config_2/sip_registration_domains/		http://192.168.1.25:12358/configurations/config_2/sip_registration_domains/
Line 77:		Line 77:


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


Line 88:		Line 88:
	PUT http://ProSBCIP:12358/configurations/configurationname/sip_registration_domains/sip_domain_name		PUT http://ProSBCIP:12358/configurations/configurationname/sip_registration_domains/sip_domain_name

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

	http://192.168.1.25:12358/configurations/config_2/sip_registration_domains/TEST_DOMAIN and changed routing_method to Contact		http://192.168.1.25:12358/configurations/config_2/sip_registration_domains/TEST_DOMAIN and changed routing_method to Contact
Line 95:		Line 95:


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


Line 101:		Line 101:


	Learn more about how to use RestFul API and Postman Tool from the following link [[Northbound_interface:RESTful]]		Learn more about how to use RestFul API and Postman Tool from the following link [[Northbound_interface:RESTful]].

Allyntree at 19:33, 13 February 2023

2023-02-13T19:33:20Z

← Older revision		Revision as of 14:33, 13 February 2023
Line 1:		Line 1:
	You can create/modify a SIP Domain in your system with RestFul API using JSON format. The JSON must be in the following format:		You can create and modify a SIP Domain in your system with RestFul API using JSON format. The JSON must be in the following format:

	<pre>		<pre>
Line 66:		Line 66:

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


	ProSBC will create a new SIP Domain from the name in the JSON file.		ProSBC will create a new SIP Domain from the name in the JSON file.
Line 76:		Line 77:


	If the new SIP Domain is created successfully, ~~you will see~~ the following ~~information~~ in the Postman Tool		If the new SIP Domain is created successfully, the following message is returned in the Postman Tool


Line 94:		Line 95:


	If the update is successful ~~you will see~~ the following ~~information~~ in the Postman Tool		If the update is successful, the following message is returned in the Postman Tool


Line 100:		Line 101:


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

Serdar Civici at 10:55, 24 January 2023

2023-01-24T10:55:38Z

← Older revision		Revision as of 05:55, 24 January 2023
Line 74:		Line 74:

	[[Image:RestFul_sip_domain_Post_Send.png\|800px\| ]]		[[Image:RestFul_sip_domain_Post_Send.png\|800px\| ]]


	If the new SIP Domain is created successfully, you will see the following information in the Postman Tool		If the new SIP Domain is created successfully, you will see the following information in the Postman Tool


	[[Image:RestFul_sip_domain_Post_Response.png\|800px\| ]]		[[Image:RestFul_sip_domain_Post_Response.png\|800px\| ]]
Line 90:		Line 92:

	[[Image:SIP_Domain_Put_Send.png\|800px\| ]]		[[Image:SIP_Domain_Put_Send.png\|800px\| ]]


	If the update is successful you will see the following information in the Postman Tool		If the update is successful you will see the following information in the Postman Tool


	[[Image:SIP_Domain_Put_Response.png\|800px\| ]]		[[Image:SIP_Domain_Put_Response.png\|800px\| ]]

Serdar Civici at 10:55, 24 January 2023

2023-01-24T10:55:08Z

← Older revision		Revision as of 05:55, 24 January 2023
Line 78:		Line 78:

	[[Image:RestFul_sip_domain_Post_Response.png\|800px\| ]]		[[Image:RestFul_sip_domain_Post_Response.png\|800px\| ]]

			==Modifiying a SIP Domain==

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

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

			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 and changed routing_method to Contact

			[[Image:SIP_Domain_Put_Send.png\|800px\| ]]

			If the update is successful you will see the following information in the Postman Tool

			[[Image:SIP_Domain_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]]

Serdar Civici at 10:46, 24 January 2023

2023-01-24T10:46:47Z

← Older revision		Revision as of 05:46, 24 January 2023
Line 60:		Line 60:
	* [[Parameter: Routing Method\|routing_method]]		* [[Parameter: Routing Method\|routing_method]]
	* [[Parameter: Forwarding Mode\|forwarding_mode]]		* [[Parameter: Forwarding Mode\|forwarding_mode]]

			==Adding a new SIP Domain==

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

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

			ProSBC will create a new SIP Domain 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/

			[[Image:RestFul_sip_domain_Post_Send.png\|800px\| ]]

			If the new SIP Domain is created successfully, you will see the following information in the Postman Tool

			[[Image:RestFul_sip_domain_Post_Response.png\|800px\| ]]

Serdar Civici at 10:42, 24 January 2023

2023-01-24T10:42:25Z

← Older revision		Revision as of 05:42, 24 January 2023
Line 1:		Line 1:
	You can create/modify a ~~route~~ in your system with RestFul API using JSON format. The JSON must be in the following format:		You can create/modify a SIP Domain in your system with RestFul API using JSON format. The JSON must be in the following format:

	<pre>		<pre>
Line 53:		Line 53:

	</pre>		</pre>

			Important parameters in the JSON file

			* [[Parameter: Name\|name]]
			* [[Parameter: Domain name\|domain_name]]
			* [[Parameter: Routing Method\|routing_method]]
			* [[Parameter: Forwarding Mode\|forwarding_mode]]

Serdar Civici: Created page with "You can create/modify a route in your system with RestFul API using JSON format. The JSON must be in the following format:

  {     "min_contact_expire": "30 seconds",..."

2023-01-24T10:35:13Z

Created page with "You can create/modify a route in your system with RestFul API using JSON format. The JSON must be in the following format: <pre> { "min_contact_expire": "30 seconds",..."

New page

You can create/modify a route in your system with RestFul API using JSON format. The JSON must be in the following format:

<pre>

{
"min_contact_expire": "30 seconds",
"max_contact_expire": "1 hour",
"enabled": true,
"routing_method": "Register Source",
"domain_name": "sip.telcobridges.com",
"advanced_parameters": {
"poll_registered_users_parameters": {
"***meta***": {
"valid_url": false
},
"poll_registered_users_interval": "20 seconds",
"poll_registered_users_user_agent": "",
"poll_registered_users": false
},
"unsubscribe_on_unregister": true,
"***meta***": {
"valid_url": false
},
"contact_expire_grace_time": "1 minute",
"strict_user_matching": false
},
"sip_registration_registrars": {},
"***meta***": {
"version": "3.1.137",
"src_path": ""
},
"naps": [
"3CX",
"OPEN_NAP"
],
"default_contact_expire": "1 hour",
"forwarding_parameters": {
"forwarding_mode": "Contact Remapping",
"***meta***": {
"valid_url": false
},
"forward_after_switchover": true,
"override_received_user_agent": false,
"max_simultaneous_register_forward": 10000,
"max_pending_register_forward": 10000,
"min_registrar_expire": "1 hour"
},
"name": "TEST_DOMAIN",
"unique_name": "sip.telcobridges.com",
"registration_method": "Forwarding",
"max_registered_users": 100000
}

</pre>