| Layer | Campaign |
| Direction | To CallGem |
| Type of Service | CG |
| Interface ID | CA |
| Message Purpose | This message removes a telephone number from one of the dialing queues on a campaign. |
| Example | RN\CNCustCare\TN01992783287 |
| Explanation | The agent application is asking for the telephone number 01992783287 to be removed from a queue in the CustCare campaign and returned to it by CallGem. |
| Notes |
This message may be sent at any time.
The location in CallGem, of the telephone number to be returned, may be in one of several queues. See Where does Softdial CallGem keep its numbers? in Number Management section. If CallGem has already begun dialing the number, then this message will be returned in an error message. If subsequently the result of the call is anything other than a call connected to an agent, then the number will always be returned in a Number Back [NB] message, with the appropriate reason code. |
| Parameters | ||||||
|---|---|---|---|---|---|---|
| Code | Name | Type | Mandatory? | Min Val | Max Val | Description |
| CN | CampaignName | string | 1 | 80 | User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ; | |
| DN | DialedNumber | string | false | 0 | 80 |
|
| SI | SessionIdentifier | string | false | 1 | 120 | Either the TN or the SI parameter must be used to identify the called party.
Used to give each called party a unique key. If omitted, CallGem assumes this parameter to be the same as the TN parameter. Session Identifiers. |
| 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 |
| TN | TelephoneNumber | string | false | 0 | 80 | Either the TN or the SI parameter must be used to identify the called party. Session Identifiers. |