API Message Guide

PM - Play Message

Layer CTI
Direction From CallGem
Type of Service CG
Interface ID CT
Message Purpose This message instructs the telephony layer to play either a sound fragment or synthesised speech into the conversation.
Example PM\TDdefault\CNCustCare\SIABC2224\SNC:/Softdial/STG/Sounds/ThankYou.wav
Explanation The telephony layer is instructed to play the ThankYou.wav sound fragment to the call with session ID ABC2224 on the CustCare campaign.
Notes The sound fragment is the filename or URI specified in the Name Space relating to a symbolic name from the application layer. The telephony layer should respond with the Play Status [PS] - Telephony to CallGem message indicating success or fail.

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

Parameters
Code Name Type Mandatory? Min Val Max Val Description
CN CampaignName string true 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 (e.g. requeue, transfer, barge).
SI SessionIdentifier string true 1 120 Session Identifier parameter
SN SymbolicName string false 1 80 This parameter is alphanumeric. The SN parameter in this instance contains the path to the sound file
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.