ProSBC:Restful API Route - Revision history

Serdar Civici: /* Modifiying a Route */

2023-01-23T10:57:34Z

Modifiying a Route

← Older revision		Revision as of 06:57, 23 January 2023
Line 71:		Line 71:
	http://192.168.1.25:12358/configurations/config_2/routes/TEST and changed called number to 123456789		http://192.168.1.25:12358/configurations/config_2/routes/TEST and changed called number to 123456789

	[[Image:~~Route_Put_Send~~.png\|800px\| ]]		[[Image:Route_Put_Send_1.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

Serdar Civici: /* Adding a new Route */

2023-01-23T10:56:47Z

Adding a new Route

← Older revision		Revision as of 06:56, 23 January 2023
Line 55:		Line 55:
	http://192.168.1.25:12358/configurations/config_2/routes/		http://192.168.1.25:12358/configurations/config_2/routes/

	[[Image:~~RestFul_route_Post_Send~~.png\|800px\| ]]		[[Image:RestFul_route_Post_Send_1.png\|800px\| ]]

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

Serdar Civici: /* Adding a new Route */

2023-01-23T10:51:07Z

Adding a new Route

← Older revision		Revision as of 06:51, 23 January 2023
Line 47:		Line 47:
	You can add a new Route with the POST command:		You can add a new Route with the POST command:

	POST http://ProSBCIP:12358/configurations/~~configuration name~~/routes/		POST http://ProSBCIP:12358/configurations/configuration_name/routes/

	ProSBC will create a new Route from the name in the JSON file.		ProSBC will create a new Route from the name in the JSON file.

Serdar Civici at 10:50, 23 January 2023

2023-01-23T10:50:41Z

← Older revision		Revision as of 06:50, 23 January 2023
Line 31:		Line 31:
	</pre>		</pre>

	~~Parameters~~ in the JSON file		Important parameters in the JSON file

	* [[Parameter: Name\|name]]		* [[Parameter: Name\|name]]
	* [[Parameter: Routeset Name\|Routeset Name]]		* [[Parameter: Called\|called]]
	* [[Parameter: Called\|~~Called~~]]		* [[Parameter: Calling\|calling]]
	* [[Parameter: Calling\|~~Calling~~]]		* [[Parameter: NAP\|nap]]
	* [[Parameter: NAP\|~~NAP~~]]		* [[Parameter: Remapped Called\|remapped_called]]
	* [[Parameter: Remapped Called\|~~Remapped Called~~]]		* [[Parameter: Remapped Calling\|remapped_calling]]
	* [[Parameter: Remapped Calling\|~~Remapped Calling~~]]		* [[Parameter: Remapped NAP\|remapped_nap]]
	* [[Parameter: Remapped NAP\|~~Remapped NAP~~]]		* [[Parameter: Source call leg remapped Profile\|remapped_source_leg_profile]]
	* [[Parameter: Source call leg remapped Profile\|~~Source call leg remapped Profile~~]]		* [[Parameter: Destination call leg remapped Profile\|remapped_destination_leg_profile]]
	* [[Parameter: Destination call leg remapped Profile\|~~Destination call leg remapped Profile~~]]

	~~Custom Parameters~~		==Adding a new Route==
	* [[~~Parameter~~: ~~prio~~\|~~prio (or priority)~~]]
	* [[~~Parameter~~: ~~additonal_naps~~\|~~additonal_naps~~]]		You can add a new Route with the POST command:
	* [[~~Parameter~~: ~~domain~~\|~~domain~~]]
			POST http://ProSBCIP:12358/configurations/configuration name/routes/

			ProSBC will create a new Route 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/routes/

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

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

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

			==Modifiying a Route==

			You can modify the existing Route with the PUT command:

			PUT http://ProSBCIP:12358/configurations/Configurationname/routes/Routename

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

			http://192.168.1.25:12358/configurations/config_2/routes/TEST and changed called number to 123456789

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

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

			[[Image:Route_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:41, 23 January 2023

2023-01-23T10:41:07Z

← Older revision		Revision as of 06:41, 23 January 2023
Line 33:		Line 33:
	Parameters in the JSON file		Parameters in the JSON file

	* [[Parameter: name~~\|Name~~]]		* [[Parameter: Name\|name]]
	* [[Parameter: Routeset Name\|Routeset Name]]		* [[Parameter: Routeset Name\|Routeset Name]]
	* [[Parameter: Called\|Called]]		* [[Parameter: Called\|Called]]

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:

 {     "called": "",     "remapped_source_leg_..."

2023-01-23T10:40:42Z

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> { "called": "", "remapped_source_leg_..."

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>
{
"called": "",
"remapped_source_leg_profile": "(same as NAP)",
"calling": "",
"name": "TO_CLIENT",
"remapped_nap": "(By registered or DNS user)",
"nap": "3CX",
"remapped_calling": "",
"remapped_called": "",
"custom_attributes": {
"private_address": "",
"weight": "",
"remapped_private_address": "",
"priority": "1",
"forward_sip_domain": "1",
"forward_sip_parameters": "1",
"***meta***": {
"valid_url": false
}
},
"remapped_destination_leg_profile": "(same as NAP)",
"routeset_name": "",
"***meta***": {
"version": "3.1.137",
"src_path": ""
}
}
</pre>

Parameters in the JSON file

* [[Parameter: name|Name]]
* [[Parameter: Routeset Name|Routeset Name]]
* [[Parameter: Called|Called]]
* [[Parameter: Calling|Calling]]
* [[Parameter: NAP|NAP]]
* [[Parameter: Remapped Called|Remapped Called]]
* [[Parameter: Remapped Calling|Remapped Calling]]
* [[Parameter: Remapped NAP|Remapped NAP]]
* [[Parameter: Source call leg remapped Profile|Source call leg remapped Profile]]
* [[Parameter: Destination call leg remapped Profile|Destination call leg remapped Profile]]

Custom Parameters
* [[Parameter: prio|prio (or priority)]]
* [[Parameter: additonal_naps|additonal_naps]]
* [[Parameter: domain|domain]]

← Older revision		Revision as of 06:50, 23 January 2023
Line 31:		Line 31:
	</pre>		</pre>

	~~Parameters~~ in the JSON file		Important parameters in the JSON file

	* [[Parameter: Name\|name]]		* [[Parameter: Name\|name]]
	* [[Parameter: Routeset Name\|Routeset Name]]		* [[Parameter: Called\|called]]
	* [[Parameter: Called\|~~Called~~]]		* [[Parameter: Calling\|calling]]
	* [[Parameter: Calling\|~~Calling~~]]		* [[Parameter: NAP\|nap]]
	* [[Parameter: NAP\|~~NAP~~]]		* [[Parameter: Remapped Called\|remapped_called]]
	* [[Parameter: Remapped Called\|~~Remapped Called~~]]		* [[Parameter: Remapped Calling\|remapped_calling]]
	* [[Parameter: Remapped Calling\|~~Remapped Calling~~]]		* [[Parameter: Remapped NAP\|remapped_nap]]
	* [[Parameter: Remapped NAP\|~~Remapped NAP~~]]		* [[Parameter: Source call leg remapped Profile\|remapped_source_leg_profile]]
	* [[Parameter: Source call leg remapped Profile\|~~Source call leg remapped Profile~~]]		* [[Parameter: Destination call leg remapped Profile\|remapped_destination_leg_profile]]
	* [[Parameter: Destination call leg remapped Profile\|~~Destination call leg remapped Profile~~]]

	~~Custom Parameters~~		==Adding a new Route==
	* [[~~Parameter~~: ~~prio~~\|~~prio (or priority)~~]]
	* [[~~Parameter~~: ~~additonal_naps~~\|~~additonal_naps~~]]		You can add a new Route with the POST command:
	* [[~~Parameter~~: ~~domain~~\|~~domain~~]]
			POST http://ProSBCIP:12358/configurations/configuration name/routes/

			ProSBC will create a new Route 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/routes/

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

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

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

			==Modifiying a Route==

			You can modify the existing Route with the PUT command:

			PUT http://ProSBCIP:12358/configurations/Configurationname/routes/Routename

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

			http://192.168.1.25:12358/configurations/config_2/routes/TEST and changed called number to 123456789

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

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

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