Applications REST API - skrusty/AsterNET-ARI-Proxy GitHub Wiki
Applications
Method | Path | Return Model | Summary |
---|---|---|---|
GET | v1/applications | Application[] | Lists active Stasis applications |
POST | v1/applications/{name} | void | Subscribes the proxy to a new Stasis application |
DELETE | v1/applications/{name} | void | Disconnects an active Stasis application |
GET | v1/applications/{name}/dialogues | Dialogue[] | Returns a list of active dialogues for an application |
GET v1/applications
Gets a list of the active Stasis applications registered on the proxy
POST v1/applications/{name}
Subscribes the proxy to a new Stasis application and registers the control channel on the proxy service bus
DELETE v1/applications/{name}
Deletes a subscription to a Stasis application on the proxy and removes the control channel.
?? This should be a graceful terminate of the Stasis application and complete only once active dialogues within the application have ended ??
GET v1/applications/{name}/dialogues
Gets a list of active dialogues for a specific application. To control a dialogue, see the Dialogue REST API
Application Models
Application
Property | Type | Summary -----------------|----------|---------------|-------- Name | string | Name of the Stasis Application Created | datetime | The datetime the application was created DialogueCount | int | The number of active dialogues in this stasis application
Dialogue Models
Dialogue
Property | Type | Summary ------------|----------|---------------|-------- Id | string | The dialogue ID (UUID/Guid format) Application | string | The associated stasis application Created | datetime | The datetime the dialogue was created MsgCount | int | The number of messages processed for this dialogue ??