1.3.2.1

Release notes for version 1.3.2.1 - 24-Sep-2024

The following new features are available in this version:

Uniform API response structure

To improve your experience in working with Orchestra APIs, we have standardized the response format for all endpoints.

Success response

The following example illustrates the typical response you would receive for a successful API call:

{    
    "result": {
        "interaction_identifier": "269144_27",
        "sound": null,
        "statement": "",
        "question": "",
        "content": [],
        "music": "",
        "action": null,
        "interaction_channel_id": null,
        "triggered_action": null,
        "last_stage": false,
        "repeat_stage": false,
        "audio_speed": "1",
        "change_mode": "action",
        "next_participant": null
    },
    "targetUrl": null,
    "success": true,
    "error": null
    "unAuthorizedRequest": false,
    "__abp": true
}

Error response

The following example illustrates the typical response you would receive if an error occurs:

{
    "result": null,
    "targetUrl": null,
    "success": false,
    "error": {
        "code": "ERXXX", //Error code
        "message": "The Error Message",
        "details": "REF_8FF9E635", //Unique reference to this error that you can use for support.
        "validationErrors": null
    },
    "unAuthorizedRequest": false,
    "__abp": true
}

Improved error messaging

To improve your experience in working with Orchestra APIs, we have added validations at different stages and included relevant HTTP 400 errors, complete with standardized error codes and descriptive messages, to help you debug your issues.

For the complete list of error codes and messages and their detailed explanations, see Error messages.

Support for fewer participants in group interactions

You can now initialize a group interaction with a minimum of 2 participants.