Versions Compared

Version Old Version 22 New Version 23
Changes made by

Rijnhard Hessel

Rijnhard Hessel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: stripped v1 code

Create Call:

The notifications for the call being joined come back via Redis LIST as, you will use BRPOP or RPOP to retrieve these

call_ref:
URL

RESTful API

Code Block
languagebash
themeMidnight
#Old method: Deprecated
GET#Restful with json body
POST http://serverurl/call.php?agent=1000&callee=0000000000&outbound_id=0123456789&call_ref=AbC123
 
#Restful with json body
POST http://serverurl/click2dial/calls
  • agent: <ext> agent extension/number
  • callee: <callee> number to dial
    • outbound_id: 
    <server_url>/click2dial/calls
    • server_url: PBX IP/Domain Address
    • agent: <ext> agent extension/number
    • callee: <callee> number to dial
    • outbound_id: <outbound_id> number to use as caller ID
    • call_ref: <custom_call_ref>  your custom call reference, (in the dialer this is the contact_ref, but call_ref is kept for backwards compatibility)

    WebRTC

    From v2.7.0 (unreleased)

    Via SIP.js for this example:

    Code Block
    languagejs
    themeMidnight
    // Creates the user agent
var userAgent = new SIP.UA({
    uri              : '<ext>@<server_url>',
    wsServers        : ['ws://<server_url>:8088/ws'],
    authorizationUser: '<ext>',
    password         : '<ext_password>',
    hackIpInContact  : true
});

// Call options
var options = {
    media: {
        constraints: {
            audio: true,
            video: false
        },
        render: {
            remote: {
                audio: document.getElementById('example-audio-tag'),
            },
        },
    }, 
    extraHeaders : [ #SIP headers for Click2Dial Settings
        'X-Platforma-Outbound-ID:<outbound_id>',
        'X-Platforma-Call-Ref:<custom_call_ref>'
    ]
};

// Make the call
var session = userAgent.invite('sip:<callee>@<server_url>', options);
    • <server_url> PBX IP/Domain Address
    • <ext> Agent extension/number
    • <ext_password> Agents Password for the Extension
    • <callee> number to dial
    • <outbound_id> number to use as caller ID
    • <custom_call_ref>  your custom call reference, (in the dialer this is the contact_ref, but call_ref is kept for backwards compatibility)

    Values:

    <ext>

    The agent extension number or the first number connected to the call

    • 3-4 digit extension
    • or same as <callee> (from v2.2.1)

    Agent Regex

    <callee>

    The number to dial:

    One of the following:

    • 0820001234
      • Length: 10 digits
      • Must start with 0
    • 27820001234
      • Length: 11 digits
      • Must start with 27
    • 0027820001234
      • Length: 13-16 digits
      • Must start with 00

    Callee Regex

    <outbound_id>

    Number to use as caller ID:

    One of the following:

    • 'random' for Random CLID (from v2.3.0, Needs Teleforge configuration)
    • 0820001234
      • Length: 10 digits
      • Must start with 0
    • 27820001234
      • Length: 11 digits
      • Must start with 27

    Outbound Caller ID Regex

    <custom_call_ref> 

    Your custom call reference specified for this call

    Alphanumeric and .-_~:

    Max length 230 characters, thereafter they are truncated

    Call Reference Regex