Document
CRM wants to connect to the API and needs the URLs to receive data in URL or JSON format
Below are some example URLs for reference
Contents
Incoming Call
End Call
Missed Call
Agent No Answer
Outgoing Call
Update Real-Time Agent Status
Click2Call Event
Check Extension Status
Spy Call Event
Event to Get Extension List in Queue
Change Extension Status in Queue
Incoming Call
When there is an incoming call to the PBX, it will ring to the employee’s phone (e.g., extension 101):
With parameter:
{CRM_URL}
: Provided by CRMphone
: The incoming phone numberqueue
: The queue of the internal number (if applicable)extension
: The internal number of the agentcallid
: The call IDevent
: The call status (ANSWER, RINGING)did
: The PBX phone number
This is the event that informs the CRM that the call has ended:
With parameter:
{CRM_URL}
: Provided by CRMcallid
: The call ID
Call Information
When the call ends, the PBX can return detailed call information:
With parameter:
{CRM_URL}
: Provided by CRMcallid
: The call IDcalldate
: The start time of the call (format: y-m-d hms)duration
: The total call durationbillsec
: The duration of the talk timestatus
: The call status (ANSWER, BUSY, etc.)did
: The PBX phone numberextension
: The agent’s internal numberphone
: The customer’s phone numberdirection
: The call direction (Inbound or Outbound)recordingfile
: The path to the call recording file
Missed Call
With parameter:
{CRM_URL}
: Provided by CRMcallid
: The call IDholdtime
: The customer's hold time (in seconds)status
: The call status (ABANDON)queue
: The name of the queuephone
: The customer's phone number
Agent No Answer
With parameter:
{CRM_URL}
: Provided by CRMcallid
: The call IDstatus
: The call status (NOANSWER)queue
: The name of the queueextension
: The agent’s internal numberphone
: The customer’s phone number
Outgoing Call
Synchronize data to inform the CRM of an outgoing call from the PBX:
With parameter:
{CRM_URL}
: Provided by CRMextension
: Agent's internal numberphone
: Outgoing phone numbercallid
: Call IDevent
: Call status (ANSWER, RINGING)
Update Real-Time Status of Agent
With parameter:
{CRM_URL}
: Provided by CRM
extension
: Agent's internal number
status
: Agent's status (*)
(*) Extension Status Values
Values | Describe |
off | Agent (phone) not register |
on | Agent (phone) available |
pause | Agent (phone) pause |
ring | Agent (phone) ringring |
talk | Agent (phone) talking |
Click2call Event
CRM runs this URL with the GET method, using URL-encoded data:
With parameter:
{PBX_URL}
: Provided by the PBX system.api/CallControl/dial
: API method name for making calls in the system.extension
: Internal extension number to call (e.g., 101).phone
: Customer phone number to call (e.g., 0938363739).key
: Company key provided by the PBX system.domain
: Company domain name provided by the PBX system.
Check the status of the extension
CRM runs this path using POST method with JSON data type:
—-
With parameter:
{PBX_URL}
: Provided by the PBX system.api/Agent/status/format/json
: The API method name of the system.key
: The company's key provided by the PBX system.ext
: The extension to be checked.
SPY Call Event
CRM runs this path using POST method with JSON data type:
—-
With parameter:
{PBX_URL}
: Provided by the PBX system.api/Agent/spy/format/json
: The API method name of the system.key
: The company's key provided by the PBX system.src
: The extension of the person initiating the spy call.dst
: The extension of the person being listened to.mode
:whisper
: listen onlythreeway
: talk to bothcaller
: talk to the callercallee
: talk to the callee
Event to Retrieve Extension List in Queue
CRM runs this path using POST method with JSON data type:
—-
With parameter:
{PBX_URL}
: Provided by the PBX system.api/Agent/all_members/format/json
: The API method name of the system.key
: The company's key provided by the PBX system.
Change Extension Status in Queue
CRM runs this path using POST method with JSON data type:
—
With parameter:
{PBX_URL}
: Provided by the PBX system.api/Agent/update_status
: The API method name of the system.key
: The company's key provided by the PBX system.exten
: The extension number to be changed.status
: The status of the extension. (0: unpaused, 1: paused)
Retrieve Call Data
CRM runs this path using POST method with JSON data type:
—
With parameter:
{PBX_URL}
: Provided by the PBX system.internal/Reports/cdr/format/json
: The API method name of the system.key
: The company's key provided by the PBX system.callid
: The call ID.startdate – enddate
: The time range. (Format: YYYY-MM-DD)
Last updated