API Message Guide

PM - Play Message

Layer Agent
Direction To CallGem
Type of Service CG
Interface ID AG
Message Purpose This message instructs CallGem to play a sound fragment to all parties connected to the call session that the agent is associated with. The sound fragment is referenced by Symbolic Name [SN].
Example PM\CNCustCare\AN2\SNThankYou
Explanation The 'ThankYou' sound fragment is played to all parties associated with Agent 2 on the CustCare campaign.
Notes In order to disable playback of the current sound the PM message should be sent without the SN parameter. The sound fragment is the filename or URI specified in the Namespace relating to a symbolic name from the application layer.

Related Links: Play Message [PM] - CallGem to Telephony

Parameters
Code Name Type Mandatory? Min Val Max Val Description
AN AgentIdentifier string 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
CN CampaignName string 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
MI MessageInterruptible boolean false 0 0 From V10.6.668 - If this parameter is specified, it signifies that the message playback can be interrupted for call control (eg requeue, transfer, barge).
RF RecordingFilename string false 1 1024 Recording Filename parameter
SN SymbolicName string false 1 80 This parameter is alphanumeric. The SN parameter is configured via the Name Space Editor in Name Spaces\_config\Sound Resources
SP Speech string false 1 4000 This parameter is alphanumeric. The SP parameter contains the text to be played to the customer through the TTS engine
TD TenantDescriptor string false 1 80 This parameter is alphanumeric and identifies to which tenant this message applies.
TK Token string false 1 80 Token parameter