Account Aliases

API for browsing, adding, editing and deleting Account Groups.

URLs

• GET /accounts/{AccountId}/aliases
  Return a list of aliases for the specified account.

• GET /accounts/aliases/{Id}
  Return a specific alias by its id.

• GET /accounts/aliases/"{Alias}"?dnis={DNIS}&realm={Realm}?AliasType={AliasType}
  Lookup an entry by its alias.
  NOTE: {Alias} must be enclosed in single or double quotes.

  Parameters:

  • dnis: Only return an {Alias} entry if it has a matching {DNIS}.
  • realm: Only return an {Alias} entry if it has a matching {Realm}.
  • AliasType (required): Type of {Alias} to return (authentication or registration).

• POST /accounts/aliases
  Create a new alias.

• PUT /account/aliases
  Update an existing alias.

• DELETE /accounts/aliases/{Id}
  Delete the specified alias.

References

Looking up a Resource (single objects, lists and tabular data)
Creating a Resource
Updating a Resource
Deleting a Resource
Accounts API

Notes

Account Alias Object

{
  "AccountAliasId": 3,
  "Dnis": "*",
  "Alias": "1234",
  "AccountId": 1,
  "AccountAliasType": "aatAuthentication",
  "Password": "",
  "SipUserId": "*"
}

Examples

GET ivrapi/Accounts/Aliases/"1234"?AliasType=authentication

{
  "status": "success",
  "message": "",
  "data": {
    "AccountAliasId": 3,
    "Dnis": "*",
    "Alias": "1234",
    "AccountId": 1,
    "AccountAliasType": "aatAuthentication",
    "Password": "",
    "SipUserId": "*"
  }
}

GET ivrapi/Accounts/Aliases/"xlite"?Realm=acme.com&AliasType=registration

{
  "status": "success",
  "message": "",
  "data": {
    "AccountAliasId": 4,
    "Dnis": "acme.com",
    "Alias": "xlite",
    "AccountId": 3,
    "AccountAliasType": "aatRegistration",
    "Password": "1234",
    "SipUserId": "johnsmith"
  }
}

Table Definition

ACCOUNT_ALIASES

This table stores different Account Aliases on the system that are used for account authentication. An account alias is typically the caller’s ANI, but could also be an IP address or another alias for the account number.