HTTP API - CALL Forward: Difference between revisions
 (Created page with "== 9.1          Set Call Forward Request == '''GET <nowiki>https://gateway_ip/api/set_port_info</nowiki>'''  == 9.2          Request Parameter == {| class="wikitable" |'''Parameter''' |'''Type''' |'''Description''' |- | colspan="3" |'''Required Parameter''' |- |port |Integer | |- |action |String |Should be “CallForward” |- |param |String |Could be like Uncondational,NoReply,  Busy,  Not_Reachable,CancelAll |- |number |String |Phone Number |}   == 9....")  | 
				No edit summary  | 
				||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
'''Set Call Forward Request'''  - '''GET <nowiki>https://gateway_ip/api/set_port_info</nowiki>'''  | |||
'''GET <nowiki>https://gateway_ip/api/set_port_info</nowiki>'''  | |||
'''Request Parameters:'''  | |||
{| class="wikitable"  | {| class="wikitable"  | ||
|'''Parameter'''  | |'''Parameter'''  | ||
| Line 29: | Line 28: | ||
|}    | |}    | ||
'''The First to Read Call Forward Request''' - '''GET <nowiki>https://gateway_ip/api/set_port_info</nowiki>'''     | |||
'''GET <nowiki>https://gateway_ip/api/set_port_info</nowiki>'''     | |||
'''The First Request Parameters:'''  | |||
{| class="wikitable"  | {| class="wikitable"  | ||
|'''Parameter'''  | |'''Parameter'''  | ||
| Line 49: | Line 47: | ||
|}  | |}  | ||
'''The Second To Read Call Forward Request''' - '''GET <nowiki>https://gateway_ip/api/get_port_info</nowiki>'''     | |||
'''GET <nowiki>https://gateway_ip/api/get_port_info</nowiki>'''     | |||
'''The Second Request Parameters:'''   | |||
{| class="wikitable"  | {| class="wikitable"  | ||
|'''Parameter'''  | |'''Parameter'''  | ||
| Line 68: | Line 65: | ||
|Should be  “CallForward”  | |Should be  “CallForward”  | ||
|}    | |}    | ||
'''Example:'''  | '''Example:'''  | ||
1.   Set call forward  | '''1.   Set call forward'''  | ||
<nowiki>https://gateway_ip/api/set_port_info?port=8&action=CallForward¶m=Uncondi</nowiki> tional&number=15013828917  | <nowiki>https://gateway_ip/api/set_port_info?port=8&action=CallForward¶m=Uncondi</nowiki> tional&number=15013828917  | ||
| Line 78: | Line 74: | ||
{"error_code":200,"sn":"xxxx-xxxx-xxxx-xxxx"}  | {"error_code":200,"sn":"xxxx-xxxx-xxxx-xxxx"}  | ||
2.   Send checking command  | '''2.   Send checking command'''  | ||
<nowiki>https://gateway_ip/api/set_port_info?port=8&action=CheckCallForward</nowiki>  | <nowiki>https://gateway_ip/api/set_port_info?port=8&action=CheckCallForward</nowiki>  | ||
| Line 84: | Line 80: | ||
{"error_code":200,"sn":"xxxx-xxxx-xxxx-xxxx"}  | {"error_code":200,"sn":"xxxx-xxxx-xxxx-xxxx"}  | ||
3.    Get result  | '''3.    Get result'''  | ||
<nowiki>https://gateway_ip/api/get_port_info?port=8&info_type=CallForward</nowiki>  | <nowiki>https://gateway_ip/api/get_port_info?port=8&info_type=CallForward</nowiki>  | ||
<nowiki>{"error_code":200,"sn":"xxxx-xxxx-xxxx-xxxx","info":[{"port":8,"CallForwardi ng":{"Unconditional":"15013828917"}}]}</nowiki>  | <nowiki>{"error_code":200,"sn":"xxxx-xxxx-xxxx-xxxx","info":[{"port":8,"CallForwardi ng":{"Unconditional":"15013828917"}}]}</nowiki>  | ||
Latest revision as of 16:40, 5 May 2024
Set Call Forward Request - GET https://gateway_ip/api/set_port_info
Request Parameters:
| Parameter | Type | Description | 
| Required Parameter | ||
| port | Integer | |
| action | String | Should be “CallForward” | 
| param | String | Could be like Uncondational,NoReply,  Busy,
 Not_Reachable,CancelAll  | 
| number | String | Phone Number | 
The First to Read Call Forward Request - GET https://gateway_ip/api/set_port_info
The First Request Parameters:
| Parameter | Type | Description | 
| Required Parameter | ||
| port | Integer | |
| action | String | Should be “CheckCallForward” | 
The Second To Read Call Forward Request - GET https://gateway_ip/api/get_port_info
The Second Request Parameters:
| Parameter | Type | Description | 
| Required Parameter | ||
| port | Integer | |
| info_type | String | Should be “CallForward” | 
Example:
1. Set call forward
https://gateway_ip/api/set_port_info?port=8&action=CallForward¶m=Uncondi tional&number=15013828917
{"error_code":200,"sn":"xxxx-xxxx-xxxx-xxxx"}
2. Send checking command
https://gateway_ip/api/set_port_info?port=8&action=CheckCallForward
{"error_code":200,"sn":"xxxx-xxxx-xxxx-xxxx"}
3. Get result
https://gateway_ip/api/get_port_info?port=8&info_type=CallForward
{"error_code":200,"sn":"xxxx-xxxx-xxxx-xxxx","info":[{"port":8,"CallForwardi ng":{"Unconditional":"15013828917"}}]}