HTTP API - CALL Forward: Difference between revisions

From Ultiroam User Docs
Jump to navigation Jump to search
No edit summary
No edit summary
 
Line 1: Line 1:
'''Set Call Forward Request'''  - '''GET <nowiki>https://gateway_ip/api/set_port_info</nowiki>'''
'''Set Call Forward Request'''  - '''GET <nowiki>https://gateway_ip/api/set_port_info</nowiki>'''


'''Request Parameter:'''
'''Request Parameters:'''
{| class="wikitable"
{| class="wikitable"
|'''Parameter'''
|'''Parameter'''
Line 30: Line 30:
'''The First to Read Call Forward Request''' - '''GET <nowiki>https://gateway_ip/api/set_port_info</nowiki>'''   
'''The First to Read Call Forward Request''' - '''GET <nowiki>https://gateway_ip/api/set_port_info</nowiki>'''   


'''The First Request Parameter:'''
'''The First Request Parameters:'''
{| class="wikitable"
{| class="wikitable"
|'''Parameter'''
|'''Parameter'''
Line 49: Line 49:
'''The Second To Read Call Forward Request''' - '''GET <nowiki>https://gateway_ip/api/get_port_info</nowiki>'''   
'''The Second To Read Call Forward Request''' - '''GET <nowiki>https://gateway_ip/api/get_port_info</nowiki>'''   


'''The Second Request Parameter:'''  
'''The Second Request Parameters:'''  
{| class="wikitable"
{| class="wikitable"
|'''Parameter'''
|'''Parameter'''

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&param=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"}}]}