MOR API did details update

Description

MOR API DID details update

Please note that only the admin, the accountant (with device management), those with permission, and the reseller can use this API.

Usage

• Call: /api/did_details_update
• Methods: POST, GET(if allowed, not recomended)

Parametres

Parameter which is included into hash:

• did_id – this is the ID of DID, which has to be updated. Required.

Note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is API_Secret_Key

Parameters which are not included into hash:

• hash - SHA1 hash constructed using did_id and API_Secret_Key ( More described in Constructing hash). Required.
• u – username to login. Required.
• call_limit – call limit of did which will be updated. Optional
• did_user_id – User ID from database whom DID should be assigned. Just free DID can be assigned to User. DID can be assigned to a Reseller or a simple User. Set -1 to make DID free. Optional
• active_from - Active from date in Unix timestamp format. Optional.
• active_till - Active till date in Unix timestamp format. Optional.
• grace_time - same as Grace Time GUI option: If call duration is less than Grace Time, it will not be accounted for, for example: Grace Time = 3s, call duration <= 3s, then price for the call = 0. Optional
• language - allows setting two letters (i.e., en, it, es, ...) language code. Optional
• did_provider_id - this is the ID of the Provider. Reseller Pro can use this as well.
• custom_sip_header - adds a custom SIP header. An empty parameter value (custom_sip_header=) removes the existing value.
• comment - main DID comment. An empty value of the parameter (comment=) clears the existing value. Optional
• reseller_comment - reseller-specific DID comment. An empty value of the parameter (reseller_comment=) clears the existing value. Optional

Request

We have API Secret Key = secret, did_id = 6511
We send:

HTML POST: http://<server_ip>/billing/api/did_details_update?u=admin&did_id=6511&call_limit=999&hash=f7de355c9b4421ce6c705b4b32c89dbcaca51e46

* Note that username is not included in hash

Returns

Success

<page>
 <status>
   <success>DID details successfully updated</success>
 </status>
</page>

After successfully updating, the DID action log record is added.

---

Errors

• <error>Access Denied</error> – Specified username (u) does not exist, or u is not an admin, reseller, or accountant with permission.
• <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
• <error>Call limit is incorrect format</error> – Specified call limit has to be 0 or a positive number.
• <error>DID is already assigned</error> – DID is already assigned to another User, Reseller, or Dial Plan.
• <error>DID was not found</error> – Specified did does not exist or it belongs to different username(u).
• <error>Active till must be greater than Active from</error>
• <error>Active till must be a valid timestamp</error>
• <error>Active from must be a valid timestamp</error>

See also

• MOR API