HTTP API - Set Port Information of Gateway

From Ultiroam User Docs
Revision as of 23:29, 3 May 2024 by Administrator (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

GET https://gateway_ip/api/set_port_info

Request Parameters:

Parameter Type Description
Required Parameter
action String Action could be slot, reset or power

Slot: choose a slot (when the gateway is a multi-sim gateway)

Reset: reset the gsm/cdma/wcdma module

Power: turn on or turn off the gsm/cdma/wcdma module

imei: to modify IMEI,param should be IMEI number: to modify number in SIM,param should

be phone number

lock: to lock SIM card,param should be PIN of the SIM

unlock: to unlock SIM card,param should be PIN of the SIM

block: block SIM unblock: unblock SIM

CallForward: to set call forward,see set call forward for detail

CheckCallForward:to send checking call forward command

param String Slot:   slot of this port(when the gateway is a multi-sim gateway), ranging from 0 to 3;

Power: could be “on” or “off”.

port Integer Port number is an integer ranging from 0 to 31

Response Parameters:

Parameter Type Description
error_code Integer Codes that may be returned: 200: Request has been processed 400: Request format is not valid.

500: other errors

sn String SN of the gateway

Example of Setting Port Information:

Request:

https://gateway_ip/api/set_port_info?port=1&action=power&param=off

Response:

{"error_code":200,"sn":"xxxx-xxxx-xxxx-xxxx”}