API Message Guide

PS - Play Status

Layer Agent
Direction From CallGem
Type of Service CG
Interface ID AG
Message Purpose This message informs the agent of the outcome of a Play Message [PM] request.
Example PS\CNCustCare\AN2\RS1
Explanation Agent 2 is informed that the PM request was successful.Recording has successfully started for the call with the session identifier 0123456 on the CustCare campaign.
Notes A successful message playback will result in RS0 being sent first to say that the message was played successfully. This will then be followed by RS1 to signify that the message has now finished.The start or termination acknowledgement may occur unsolicited. If the campaign or agent is set to blanket record calls, CallGem will generate the acknowledgements as a means to drive application state machine logic consistently.

If the PM was unsuccessful only one PS message will be sent with the RS2 parameter.The start or termination acknowledgement may occur unsolicited. If the campaign or agent is set to blanket record calls, CallGem will generate the acknowledgements as a means to drive application state machine logic consistently.

Last Changed Pre V9.2
Parameters
Code Name Type Mandatory? Min Val Max Val Description
AN AgentIdentifier string true 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
CN CampaignName string true 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
RS ResourceStatus int true 0 4 This parameter may have the following values:
0OK
1Finished
2Telephony problem
TD TenantDescriptor string false 1 80 This parameter is alphanumeric and identifies to which tenant this message applies.