MAPI Manual

NAME

UPDATE_GATEWAY

FUNCTION

Update a gateway

SYNOPSIS

mcp_channeltype_id, mcp_gateway_id, gateway_name, gateway_type, assign_type, username, password, token, outbound_process, inbound_process, gateway_ip, gateway_config, priority, isactive, gateway_comm_mode, max_online, diagnosis_continuesfailed, testrun_interval, international_prefix, gateway_preserve_1, gateway_preserve_2, note

DESCRIPTION

This function allows root users to update a gateway.

Required Parameters

* action: UPDATE_GATEWAY.

* mcp_channeltype_id: channel type of the gateway. Available channel types are:

  • voice,
  • email, 
  • sms, 
  • CHANNELTYPE_LINKACTION, 
  • CHANNELTYPE_TEXT2SPEECH.

* mcp_gateway_id: specifies ID of the gateway that needs to be updated.


* gateway_name: name of gateway.


* gateway_type: type.

* assign_type: assign type.

* username: username for the gateway.

* password: password.

* token:

* outbound_process: process for outbound messages/calls.

* inbound_process: process for inbound messages/calls.

* gateway_ip:

* gateway_config:

* priority: priority of the gateway. "1" means the highest priority.

* isactive: specifies whether the gateway is active or not. "1" mean active.

* gateway_comm_mode: communication mode. Available modes are listed below:

  • "RECV_ONLY": used for receiving only.
  • "SEND_ONLY": used for sending only.
  • "DUPLEX": used for two-way(send and receive) communication.
* max_online: a number.

* diagnosis_continuesfailed:

* testrun_interval:

* international_prefix:

* gateway_preserve_1:

* gateway_preserve_2:

* note: a note about the gateway.

RETURN DATA

ROLE PERMITTED

Root

EXAMPLES

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

Mweb v2.0 YVNTECH 2014