API

CloudIVR jest w trakcie zmian. Dokumenty zostaną zaktualizowane już wkrótce!

Autoryzacja oparta jest na nagłówku HTTP "Apikey", który zwraca wartość z ekranu głównego

General info:

  • response - JSON

  • success - http 200

  • error - http != 0, Obiekt JSON zawierający pole msg z komunikatem o błędzie

Local Agent

GET /api/v1/local-agents

uzyskaj informacje o lokalnych operatorach

GET /api/v1/local-agents/[ID]

uzyskaj informacje o lokalnym operatorze

PUT /api/v1/local-agents/[ID]/snooze

drzemka agenta, zwraca obiekt agenta (jak GET)

PUT /api/v1/local-agents/[ID]/wake

wywołanie Agenta, zwraca obiekt Agenta (jak GET)

Database (Global Variables)

GET /database/[key]

zwraca klucz z lokalnej bazy danych

POST /database/[key]

ustawienie parametru wartości dla klucza w lokalnej bazie danych

Alias Number

GET /channels/[id]/alias-numbers

zwraca listę aliasów dla numeru telefonu

POST /channels/[id]/alias-numbers/tag

wybierz najmniej ostatnio używany alias i nadaj mu tag

wymagane parametry:

  • tag (string)

  • minutes (integer) - trwałość znacznika

DELETE /channels/[id]/alias-numbers/:id/tag

usuń tag (zanim wygaśnie)

BLOKOWANIE IDENTYFIKATORA ROZMÓWCY

Każdy może zadzwonić na nowo oznaczony numer. Pierwszy dzwoniący jest przypisany do numeru (alias). Od tego momentu tylko ten dzwoniący (numer) będzie mógł dzwonić na ten alias, aż do wygaśnięcia tagu.