The QuBe Live Call module is used to create a seamless experience with a call back function integration between a web application and QuBePBX

Live Call set-up

To use Live Call module, Live Call Profile must be configured first.

URL: /func/live-call

Parameters

• Click the Create Announcement button
• Name
  • Profile name, must be unique
• Description
  • Profile description
• Queue
  • QuBe Queue where calls is placed to
• Caller ID
  • A Caller ID used for outbound call to provided number
• Token
  • Authorization token to authenticate API requests (at least 50 characters)
• Ring Timeout
  • • Ring Timeout – Timeout (in seconds) of outbound call dialing to provided number, if call is not answered within this time out then error is returned

Call Flow

1. Request to API.
2. Making outbound call to provided number with Caller ID set in a settings. Call is made immediately.
3. If call answered it is put into a queue immediately and success response is returned. Otherwise, error response is returned.
4. Call is handled by Queue, application ends process of a request.

API Requests

Authorization

• Authorization is based on token. Token must be placed in HTTP Header “Authorization”. Header must starts with “Token” string.
• Example: “Token 4c9LC0Nrc2A3cj4A8BBgUYfzNAxg27”

Errors

• HTTP error 401.
  • Invalid authorization parameters raise. Content-type: text/plain. Normally caused by incorrect Profile ID or incorrect Authorization Header name or value.
• HTTP error 503.
  • Authorization is failed because of incorrect token value. Content-type: text/plain.

Get Queue Members State.

URL: /func/live-call/state/{LIVE_CALL_PROFILE_ID}/

Method: GET

Response

• Content-type: application/json

Response parameters

• Available – number of available (logged in, valid, not paused) members. Type - integer
• Free – number of free members (can accept the call at the request time). Type - integer
• Success response code 201.

Errors

• Error code: 500
  • Error content-type: application/json

Initiate a call to provided number.

URL: /func/live-call/call/{LIVE_CALL_PROFILE_ID}/

Method: POST

Content-type: application/json

Request parameters:

• • number – number to call to, must be numeric only. Type - string

Response

• Content-type: application/json

Response parameters

• Message – number of available (logged in, valid, not paused) members
• Success response code 201.

Errors

• Error code: 500
  • Error content-type: application/json
  • Raised on error during call origination.
• Error code: 400
  • Error content-type: application/json
  • Raised on failed request parameters validation.