Perform State Transition

Contents

Description

Performs a state transition for a given service.
In many cases, your application is responsible for completing a given state and starting a new state, both in the context of a single interaction. In that context, your application can use this operation (instead of two separate Start State and Complete State operations) to reduce both the data duplication and the overall UCS services workload.

The hash of the following fields describing the state from which the service is transitioning:

state_id (mandatory) : The 32-bit ID of the state to complete.

disposition (optional): The unique ID for the business disposition assigned to the given state. For instance, this can be the DB ID of a Business Attribute used to enumerate a given organization’s business dispositions<ref name="business">

disposition_desc (optional): The text description which provides additional context on the business disposition. Limited to 64 characters.

to

hash

yes

The hash of the following fields, which describe the state into which the service is transitioning:

state_type (mandatory): The unique ID associated with the type of service, typically the DB ID of a value in the Service Type Business Attribute<ref name="business"/>.

est_duration (optional): The estimated service duration in seconds.

Important

The following fields apply both to the state to complete and the state to start.

session_id

string

no

The ID of the related session. For example, the orchestration session or any other business session.

interaction_id

string

no

The ID of the related Genesys interaction. This ID can be used by other Genesys reporting products such as Stat Server, URS, Composer, and GVP.

application_type

long or string

no

The unique ID associated with the type or class<ref name="business"/> of application issuing the service event. May be used to group related applications, potentially across resource types.

application_id

integer

no

The unique ID (Genesys DB ID) for the application issuing the service event, such as a GVP VoiceXML application or an Orchestration SCXML application.

resource_type

long or string

no

The unique ID associated with the type or class<ref name="business"/> of resource which provides the service (such as GVP, Agent Desktop, or Orchestration).

resource_id

integer

no

The unique DB ID for the specific resource which provides the service. For instance:

the Genesys DB ID of a specific GVP or orchestration platform.

the DB ID of a given agent, according to the context.

media_type

long or string

no

The media type<ref name="business"/> applicable to the given state. For example: e-mail, voice, chat, etc.

timestamp

date/time

no

The UTC time at which the event was raised, with a precision of milliseconds, using the ISO 8601<ref name="ISO 8601">http://en.wikipedia.org/wiki/ISO_8601</ref> representation : [YYYY]-[MM]-[DD]T[HH]:[mm]:[ss].[SSS]Z.

Important

If the application does not specify this timestamp, the server does it when the event is processed.

<extension key>

Any JSON type

no

State attached data as key-value pairs. You can add as many key-value pairs as needed.

<references />

Response

The Context Management Service API answers with HTTP codes for every request.
The following table shows the correct response for a successful request. See HTTPResponseCodesandErrors for further details on the possible codes that this operation can return.