Skip to main content
Skip table of contents

Architect API

By integrating these prebuilt API Rules into AppBase, users can easily harness the Genesys Conversation API's full potential. These rules might include predefined request and response formats, authentication mechanisms, error handling procedures, and other essential components that are essential for successful API communication.


Methods in Extensions

Before executing these methods, you should init auth token:

C#
using DCM.GenesysHelper.Services;
 
string pureCloudUrl = ConfigurationManager.AppSettings.Get("PURECLOUD_URL");
string clientId = ConfigurationManager.AppSettings.Get("PURECLOUD_CLIENTID");
string clientSecretId = ConfigurationManager.AppSettings.Get("PURECLOUD_CLIENTSERCRETID");
int regionHost = DcmConvertHelper.SafeObjectToInt(ConfigurationManager.AppSettings.Get("PURECLOUD_REGIONHOST"));
 
AuthService authService = new AuthService();
authService.SetAuthToken(pureCloudUrl, clientId, clientSecretId, (PureCloudRegionHosts)regionHost);

How to get debug enabled flag. Debug data will be available in Conversation History (if we have ConversationId) or the system monitor.

C#
string result = request.AsString("GEN_ADVANCED_LOGGING");
bool isDebugEnabled = result == "1";


MethodDefinitions

DCM.GenesysHelper.Services.ArchitectService.GetFlows

Description: Returns flows by query.

Input:

  • flowRequest: FlowRequest
    • Type: List<string> - Type Valid valuesbot, commonmodule, digitalbot, inboundcall, inboundchat, inboundemail, inboundshortmessage, outboundcall, inqueuecall, inqueueemail, inqueueshortmessage, speech, securecall, surveyinvite, voice, voicemail, workflow, workitem
    • PageNumber: int, default = 1
    • PageSize: int, default = 100
    • SortBy: string
    • SortOrder: string
    • Id: List<string>
    • Name: string
    • Description: string
    • NameOrDescription: string
    • PublishVersionId: string
    • EditableBy: string
    • LockedBy: string
    • LockedByClientId: string
    • Secure: string - 

      Secure Valid values: any, checkedin, published

    • Deleted: bool
    • IncludeSchemas: bool
    • PublishedAfter: string
    • PublishedBefore: string
    • DivisionId: List<string> - division ID(s)
  • isDebugEnabled: bool, default = false

Output:

  • List<PureCloudPlatform.Client.V2.Model.Flow> 

Example:

C#
using DCM.GenesysHelper.Services;  
 
FlowRequest flowRequest = new FlowRequest();
flowRequest.PageNumber = 1;
flowRequest.PageSize = 25;
var flows = new ArchitectService().GetFlows(flowRequest);


JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.