Termination (Attempt)

Introduction

An SCP LUA script may request that the call be terminated to a B-Party by sending INAP Continue or INAP Connect on the SSP transaction using RequestReportBCSMEvent to arm for the Answer, NoAnswer, Busy, RouteSelectFailure, and Abandon event detection points.

The Disconnect EDPs are not armed. There will be no ApplyCharging, nor CallInformationRequest.

The use of FurnishChargingInformation and/or SendChargingInformation is optional.

If an SRP is currently open then a prior DisconnectForwardConnection will be sent on the SSP transaction, and any external SRP transaction will be ended according to the applicable SRP configuration.

The processing will suspend until one of the armed EDPs is returned, or a guard timer expires. If the call is Answered or Abandoned or timed-out then no further telephony methods are permitted.

If the call result is Busy, NoAnswer, or RouteSelectFailure, then the service logic may carry on and attempt other telephony actions.

The LhoScpLuaService Termination (Attempt) API

.termination_attempt

This method provides full access to the Termination (Attempt) mechanism and is provided for use by custom service developers. In the majority of scenarios, one of the subsequently-described convenience methods should be sufficient and preferable. However, this full-featured alternative is provided for use by complex or non-standard services.

This method sends INAP Connect if the .address_digits is present, or INAP Continue if the address digits are not specified.

This method takes a single details parameter which is a LUA table with the following structure:

The termination_attempt method returns a structure indicating the result of the termination attempt.

Example (connect to called party with a prefix, no FCI, no SCI, redirection):

    local n2svcd = require "n2.n2svcd"
    local scp_api = require "n2.n2svcd.scp"

    local handler = function (scp_call)

        local result = scp_api.termination_attempt ({
            address_digits = '1703' .. scp_call.normalised_called_party,
            redirecting_digits = '00889001234',
            redirection_info = { reason = 4, counter = 1 }
        })

        if (result.answered) then
            n2svcd.notice ("CALL ANSWERED = YES")

        else
            if (result.controlled) then
                n2svcd.notice ('Controlled after EDP Name = %s', result.edp_name)
                scp_api.release_call (5)

            else
                n2svcd.notice ('Control Lost after EDP Name = %s', result.edp_name)
            end
        end

        return 
    end

    return n2svcd.handler (handler)

.continue_attempt

The continue_attempt method takes the following arguments:

The continue_attempt method returns the same result structure as termination_attempt.

Example (continue with 30 second NoAnswer timer):

    local n2svcd = require "n2.n2svcd"
    local scp_api = require "n2.n2svcd.scp"

    local handler = function (scp_call)

        local result = scp_api.continue_attempt (30)

        -- If result.controlled = true then we are still in control of the call.
        if (result.controlled) then
            n2svcd.notice ('Controlled after EDP Name = %s', result.edp_name)
            scp_api.release_call (5)

        else
            n2svcd.notice ('Control Lost after EDP Name = %s', result.edp_name)
        end

        return 
    end

    return n2svcd.handler (handler)

.connect_attempt

An SCP LUA script may request that the call be terminated to a B-Party by sending INAP Connect on the SSP transaction using RequestReportBCSMEvent to arm for the Answer, NoAnswer, Busy, RouteSelectFailure, and Abandon event detection points.

The Disconnect EDPs are not armed. There will be no ApplyCharging, nor CallInformationRequest.

The use of FurnishChargingInformation and/or SendChargingInformation is optional.

If an SRP is currently open then a prior DisconnectForwardConnection will be sent on the SSP transaction, and any external SRP transaction will be ended according to the applicable SRP configuration.

The processing will suspend until one of the armed EDPs is returned. If the call is Answered or Abandoned then no further telephony methods are permitted after performing continue_attempt. If the call result is Busy, NoAnswer, or RouteSelectFailure, then the service logic may carry on and attempt other telephony actions.

The connect_attempt method takes the following arguments:

The connect_attempt method returns the same result structure as termination_attempt.

Example (connect to called party with a prefix, default NoAnswer, with FCI):

    local n2svcd = require "n2.n2svcd"
    local scp_api = require "n2.n2svcd.scp"

    local handler = function (scp_call)
        local called_party = '1703' .. scp_call.normalised_called_party

        -- Binary in LUA is decimal-specified.
        local fci_bin = '\01\02\03\04\255\238\221'

        local result = scp_api.connect_attempt (called_party, nil, fci_bin)
        if (result.answered) then
            n2svcd.notice ("CALL ANSWERED = YES")
        end

        -- This will automatically release the call (if needed) with default release cause.
        return 
    end

    return n2svcd.handler (handler)

Example (connect to called party with a prefix, default NoAnswer, no FCI/SCI, B-Party beep with explicit ID):

    local n2svcd = require "n2.n2svcd"
    local scp_api = require "n2.n2svcd.scp"

    local handler = function (scp_call)
        local called_party = '1703' .. scp_call.normalised_called_party

        local result = scp_api.connect_attempt (called_party, nil, nil, nil, { id = 1300 })
        if (result.answered) then
            n2svcd.notice ("CALL ANSWERED = YES")
        end

        -- This will automatically release the call (if needed) with default release cause.
        return 
    end

    return n2svcd.handler (handler)