reject Action

Rejects an inbound call that is still in the inbound state, specifying a cause for the rejection.

language wrappers and examples

reject properties are:

PropertyRequired/OptionalDefaultDescription
causeoptional"rejected"The cause of the rejection. One of:
  • "busy"
  • "noanswer"
  • "unobtainable"
  • "changed"
  • "outoforder"
  • "barred"
  • "rejected"
  • "nochannels"
  • "congestion"
raw causeoptional-A raw protocol-specific clearing cause that is passed directly to the service provider, for example, a SIP response code (see SIP Response Codes). A string provided here will override cause.
  • Examples:

    • Reject a call using the default cause:

      "reject" : 
      {
      }
      
    • Reject a call and specify a busy cause:

      "reject" :
      {
          "cause" : "busy"
      }
      
    • Reject a call specifying a SIP 'Busy Here' raw cause:

      "reject" :
      {
          "raw_cause" : "486",
      }
      
  • Reject Class
    Namespace: Aculab.Cloud.RestAPIWrapper
    Assembly: Aculab.Cloud.RestAPIWrapper.dll

    An action to reject an inbound call that is still in the inbound state.

    • public class Reject : TelephonyAction
      {
          // Constructors
          public Reject();
          public Reject(string cause);
      
          // Members
          public string Cause;
          public string RawCause;
      }
      

      Examples:

      • Reject a call using the default cause:

        List<TelephonyAction> actions = new List<TelephonyAction>();
        
        actions.Add(new Reject());
        
      • Reject a call and specify a busy cause:

        List<TelephonyAction> actions = new List<TelephonyAction>();
        
        actions.Add(new Reject("busy"));
        
      • Reject a call specifying a SIP 'Busy Here' raw cause:

        List<TelephonyAction> actions = new List<TelephonyAction>();
        
        var reject = new Reject
        {
            RawCause = "486"
        };
        actions.Add(reject);
        
    • public class Reject : TelephonyAction
      {
          // Constructors
          public Reject();
          public Reject(string cause);
      
          // Members
          public string Cause;
          public string RawCause;
      }
      

      Examples:

      • Reject a call using the default cause:

        List<TelephonyAction> actions = new List<TelephonyAction>();
        
        actions.Add(new Reject());
        
      • Reject a call and specify a busy cause:

        List<TelephonyAction> actions = new List<TelephonyAction>();
        
        actions.Add(new Reject("busy"));
        
      • Reject a call specifying a SIP 'Busy Here' raw cause:

        List<TelephonyAction> actions = new List<TelephonyAction>();
        
        var reject = new Reject
        {
            RawCause = "486"
        };
        actions.Add(reject);
        
    • public class Reject : TelephonyAction
      {
          // Constructors
          public Reject();
          public Reject(string cause);
      
          // Members
          public string Cause;
          public string RawCause;
      }
      

      Examples:

      • Reject a call using the default cause:

        List<TelephonyAction> actions = new List<TelephonyAction>();
        
        actions.Add(new Reject());
        
      • Reject a call and specify a busy cause:

        List<TelephonyAction> actions = new List<TelephonyAction>();
        
        actions.Add(new Reject("busy"));
        
      • Reject a call specifying a SIP 'Busy Here' raw cause:

        List<TelephonyAction> actions = new List<TelephonyAction>();
        
        var reject = new Reject
        {
            RawCause = "486"
        };
        actions.Add(reject);
        
  • Reject Class
    Namespace: Aculab.Cloud.RestAPIWrapper
    Assembly: Aculab.Cloud.RestAPIWrapper.dll

    An action to reject an inbound call that is still in the inbound state.

    • Public Class Reject
          Inherits TelephonyAction
      
          ' Constructors
          Public Sub New ()
          Public Sub New (cause As String)
      
          ' Members
          Public Property Cause As String
          Public Property RawCause As String
      End Class
      

      Examples:

      • Reject a call using the default cause:

        Dim actions = New List(Of TelephonyAction)
        
        actions.Add(New Reject())
        
      • Reject a call and specify a busy cause:

        Dim actions = New List(Of TelephonyAction)
        
        actions.Add(New Reject("busy"))
        
      • Reject a call specifying a SIP 'Busy Here' raw cause:

        Dim actions = New List(Of TelephonyAction)
        
        Dim reject = New Reject()
        reject.RawCause = "486"
        actions.Add(reject)
        
    • Public Class Reject
          Inherits TelephonyAction
      
          ' Constructors
          Public Sub New ()
          Public Sub New (cause As String)
      
          ' Members
          Public Property Cause As String
          Public Property RawCause As String
      End Class
      

      Examples:

      • Reject a call using the default cause:

        Dim actions = New List(Of TelephonyAction)
        
        actions.Add(New Reject())
        
      • Reject a call and specify a busy cause:

        Dim actions = New List(Of TelephonyAction)
        
        actions.Add(New Reject("busy"))
        
      • Reject a call specifying a SIP 'Busy Here' raw cause:

        Dim actions = New List(Of TelephonyAction)
        
        Dim reject = New Reject()
        reject.RawCause = "486"
        actions.Add(reject)
        
  • class Reject extends TelephonyAction

    Represents a reject action.

    Class synopsis:

    // Constructors:
    public Reject()
    public Reject(String cause)
    
    // Members:
    public void setCause(String cause)
    public void setRawCause(String rawCause)
    

    Examples:

    • Reject a call using the default cause:

      List<TelephonyAction> actions = new ArrayList<TelephonyAction>();
      
      actions.add(new Reject());
      
    • Reject a call and specify a busy cause:

      List<TelephonyAction> actions = new ArrayList<TelephonyAction>();
      
      actions.add(new Reject("busy"));
      
    • Reject a call specifying a SIP 'Busy Here' raw cause:

      List<TelephonyAction> actions = new ArrayList<TelephonyAction>();
      
      Reject rejectAction = new Reject();
      rejectAction.setRawCause("486");
      
      actions.add(rejectAction);
      
  • class Reject

    Represents a reject action.

    Class synopsis:

    # Reject object:
    Reject(cause=None, raw_cause=None)
    

    Examples:

    • Reject a call using the default cause:

      # Create a list of actions that will be passed to the TelephonyResponse constructor
      list_of_actions = []
      
      list_of_actions.append(Reject())
      
    • Reject a call and specify a busy cause:

      # Create a list of actions that will be passed to the TelephonyResponse constructor
      list_of_actions = []
      
      list_of_actions.append(Reject(cause='busy'))
      
    • Reject a call specifying a SIP 'Busy Here' raw cause:

      # Create a list of actions that will be passed to the TelephonyResponse constructor
      list_of_actions = []
      
      list_of_actions.append(Reject(raw_cause='486'))
      
  • The Reject class

    Introduction

    Represents a reject action.

    Class synopsis

    class Reject extends ActionBase {
    
        /* methods */
        public __construct()
        public self setCause(string $cause)
        public self setRawCause(string $raw_cause)
        public static Reject cause(string $cause)
        public static Reject rawCause(string $raw_cause)
    }
    

    Examples:

    • Reject a call using the default cause:

      $response->addAction(new Aculab\TelephonyRestAPI\Reject());
      
    • Reject a call and specify a busy cause:

      $response->addAction(Aculab\TelephonyRestAPI\Reject::cause('busy'));
      
    • Reject a call specifying a SIP 'Busy Here' raw cause:

      $reject = new Aculab\TelephonyRestAPI\Reject();
      $reject->setRawCause('486');
      $response->addAction($reject);