MAPI Manual

NAME

UPDATE_ACCOUNT_BILLRATE

FUNCTION

Update an account bill rate

SYNOPSIS

action: UPDATE_ACCOUNT_BILLRATE  
org_id
mcp_channeltype_id
rate_flag
mcp_billing_rate_unit_id
rate_cc
rate_sw
min_rate 
description

login_name 
login_passwd 
or 
login_name 
session_id 
or 
device_id 

DESCRIPTION

This function allows account managers to update an existing account bill rate of an organisation. Both GET and POST methods can be used to perform the request. Note: The parameters "mcp_channeltype_id" and "rate_flag" are the primary key for a bill rate, and these values cannot be updated.

Required Parameters
* action: specifies the requested function. Sets to UPDATE_ACCOUNT_BILLRATE.
* org_id: the organization ID.
* mcp_channeltype_id: the channel type. The values are "sms", "voice", "email" or "clicktodial". This value cannot be changed.
* rate_flag: specifies the pattern of the numbers to which the bill rates will be applied. For example, "612%" represents any number beginning with "612". This value needs to be URL encoded. This value cannot be changed.
* mcp_billing_rate_unit_id: ID of billing rate unit. This specifies how the account usage will be charged. The rates can be calculated based on either the quantity of messages sent or the amount of time used.
* rate_cc: the basic rate. The format of this value should be "x.xxxx", e.g., "0.3000".
* rate_sw: the service charge. The format of this value should be "x.xxxx", e.g., "0.3000".
* min_rate: the minimum rate. The format of this value should be "x.xxxx", e.g., "0.3000".
* description: the description of the rates.

* login_name: the login name for authenticating the user.
* login_passwd: the login password for authenticating the user.
or
* login_name: the login name for authenticating the user.
* session_id: the session ID for authenticating the user.
or
* device_id: a unique ID of the device. The system can use it as a key to identify users.

RETURN DATA

For each valid request, the server provides a response in XML format.
The response contains the following attributes:
* msg: a string indicating the rate has been updated successfully.

For an invalid request, the response XML contains the following attribute:
* msg: a string containing the error message.

ROLE PERMITTED

Account manager, root

EXAMPLES

The following example shows a successful HTTP GET request and response.

Request:
http://app02.yvntech.com/MapIHttpS/MapIS?action=UPDATE_ACCOUNT_BILLRATE&org_id=10&mcp_channeltype_id=clicktodial&rate_flag=614%25&mcp_billing_rate_unit_id=1&rate_cc=0.2000&rate_sw=0.1000&min_rate=0.5000&description=billing%20clicktodial%20rate&device_id=demoid

Response:
<result tftype='1' infotype='0'>
    <field name='msg'>SUCCESS</field>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

ADD_ACCOUNT_BILLRATE, LIST_ORGS

Mweb v2.0 YVNTECH 2014