CloudIVR API [beta]

CloudIVR API is undergoing changes. Docs will be updated soon!

Authorization is based on ”Apikey” HTTP header which returns the value from the main screen.

• response - JSON
• success - http 200
• error - http != 0, JSON object containing msg field with an error message

get information about local Agents

get information about a local Agent

snooze an Agent, returns the Agent object (like GET)

wake an Agent, returns the Agent object (like GET)

return a key from a local database

set a value parameter for a key in a local database

return a list of aliases for a telephone number

select the least recently used alias and assign it a tag

required parameters:

• tag (string)
• minutes (integer) - tag lifetime

delete a tag (before it expires)

Everyone can call a newly tagged number. The first caller is assigned to the number (alias). Since then, only this caller (number) will be able to call this alias, till the tag lifetime expiration.