Fidelity APIs

Telephony

© JUSAN 2021
C/Vivero, 5 – planta 1ª
Document of specifications for CP/PM
28040 Madrid, Spain
Tel: +34(91) 456 01 10
data integration (booking&CDR)
Fax: +34(91) 553 14 11
info@jusan.es

www.jusan.es
 Project Request by Request Date
Fidelity Api - Telephony Jusan S.A. 26/09/2018

Doc Reference Doc version Last Saved Time Doc Type

API_FID_Telephony 1.0.0 26/05/2021 13:02 RD003 - API_Integration

1. DOCUMENT CONTROL

1.1. Purpose and Scope of Document

This document describes the technical procedure to use the TelephonyAPI.

1.2. Terms and Abbreviatons

URL – Unif orm Resource Locator

HTML - Hypertext Markup Language
HTTP - Hypertext Transf er Protocol
REST - Representational State Transf er
API - Application Programming Interface

1.3. Reference Documents

Document Author/s Description Date

1.4. Participants

Name Cod Company Role

Andrei-Gabriel Budea AB JUSAN S.A. Software Engineer
Pedro Lamas García PL JUSAN S.A. Software Engineer

1.5. Revision

Version Author Changes Date

1.1.0 PL Document creation 2018-09-26

© 2021 JUSAN S.A. Página 2

 Project Request by Request Date
Fidelity Api - Telephony Jusan S.A. 26/09/2018

Doc Reference Doc version Last Saved Time Doc Type

API_FID_Telephony 1.0.0 26/05/2021 13:02 RD003 - API_Integration

2. INTRODUCTION

Telephony API gives third party applications the possibility to use phone
interface methods.

2.1. Service type:

- RESTful API
2.2. URL
- https://[server]:[port]/telephonyapi/
2.3. Security
- HTTPS
- Basic authentication RFC 2617, HTTP Authentication: Basic and Digest
Access Authentication (user and password needs to be registered previously in
our system)
3. INTERFACE

3.1. Methods

https://[server]:[port]/telephonyapi/api/telephony/dia l
Summary Makes a call
Type POST
Header Content-Type application/json
Parameters data {
"from": "131",
"to": "163",
"agtRef": "AGB"
}
Returns HTTP status 403: f orbidden indicates that the server ref uses to f ulf ill
the request.
HTTP status 500: InternalServerError indicates that a generic error
has occurred on the server
HTTP status 200: OK indicates that the request succeeded and
returns the call guid.

https://[server]:[port]/telephonyapi/api/telephony/dia lAsync
Summary Makes an asynchronous call
Type POST
Header Content-Type application/json
Parameters data {
"from": "131",
"to": "163",
"agtRef": "AGB"
}
Returns HTTP status 403: f orbidden indicates that the server ref uses to f ulf ill
the request.
HTTP status 500: InternalServerError indicates that a generic error
has occurred on the server

© 2021 JUSAN S.A. Página 3

 Project Request by Request Date
Fidelity Api - Telephony Jusan S.A. 26/09/2018

Doc Reference Doc version Last Saved Time Doc Type

API_FID_Telephony 1.0.0 26/05/2021 13:02 RD003 - API_Integration

HTTP status 200: OK indicates that the request succeeded and

returns true or f alse if it couldn´t connect to the server .

https://[server]:[port]/telephonyapi/api/telephony/getcontactinfo
Summary Retrieves information about the contact status associated to the given
campaign and phone.
Type POST
Header Content-Type application/json
Parameters data {
"campaign": " RECALL_SA",
" phone": "163"
}
Returns HTTP status 403: f orbidden indicates that the server ref uses to f ulf ill
the request.
HTTP status 500: InternalServerError indicates that a generic error
has occurred on the server
HTTP status 200: OK indicates that the request succeeded and
returns the contact status:
{ "Status": "Processed"}

https://[server]:[port]/telephonyapi/api/telephony/getcallinfo
Summ Retrieves inf ormation about the call associated to the given guid.
ary
Type POST
Header Content-Type application/json
Param data {
eters "guid": "8cb45c39-9f76-497e-bc49-
5ed5504d6765"
}
Return HTTP status 403: f orbidden indicates that the server ref uses to f ulf ill the
s request.
HTTP status 500: InternalServerError indicates that a generic error has
occurred on the server
HTTP status 200: OK indicates that the request succeeded and returns the
call info:
{
"Guid": "8cb45c39-9f76-497e-bc49-5ed5504d6765",
"CTICallId": "65972",
"CalledPhone": "163",
"EndTime": "2018-07-11T12:23:05.89",
"Duration": "0",
"Result": "ANSWERED",
"RefAgent": null,
"RecordFile":
"c:\\recordings\\20180323\\B$SIPDED2$anonymous$37167066600$DED2$3K1_T
ELEPHONY$10d07m2018y$10h05m41s$0a7In",
"Type": "OUTGOING"
}

© 2021 JUSAN S.A. Página 4

 Project Request by Request Date
Fidelity Api - Telephony Jusan S.A. 26/09/2018

Doc Reference Doc version Last Saved Time Doc Type

API_FID_Telephony 1.0.0 26/05/2021 13:02 RD003 - API_Integration

https://[server]:[port]/telephonyapi/api/telephony/setcalladditiona ldata
Summary Sets additional data to the call.
Type POST
Header Content-Type application/json
Parameters data {
"guid": "8cb45c39-9f76-497e-bc49-
5ed5504d6765",
"values": [{"key": "name", "value":
"Andrés"}]
}
Returns HTTP status 403: f orbidden indicates that the server ref uses to f ulf ill
the request.
HTTP status 500: InternalServerError indicates that a generic error
has occurred on the server
HTTP status 200: OK indicates that the request succeeded

https://[server]:[port]/telephonyapi/api/telephony/getcalladditiona ldata
Summary Retrieves additional data about the call associated to the given guid.
Type POST
Header Content-Type application/json
Parameters data {
"guid": "8cb45c39-9f76-497e-bc49-
5ed5504d6765"
}
Returns HTTP status 403: f orbidden indicates that the server ref uses to f ulf ill
the request.
HTTP status 500: InternalServerError indicates that a generic error
has occurred on the server
HTTP status 200: OK indicates that the request succeeded and a list
of additional data:
[{"key": "name", "value": "Andrés"}]

https://[server]:[port]/telephonyapi/api/telephony/setCallFileName
Summary Sets dif f erent f ile name to the call.
Type POST
Header Content-Type application/json
Parameters data {
"extension": "121",
"filename": "\\192.168.1.1\REQ\test.wav"
}
Returns HTTP status 403: f orbidden indicates that the server ref uses to f ulf ill
the request.
HTTP status 500: InternalServerError indicates that a generic error
has occurred on the server
HTTP status 200: OK indicates that the request succeeded and a list
of additional data:
[{"Success": true, "ErrorCode": 0, "ErrorDescription": ""}]

© 2021 JUSAN S.A. Página 5

 Project Request by Request Date
Fidelity Api - Telephony Jusan S.A. 26/09/2018

Doc Reference Doc version Last Saved Time Doc Type

API_FID_Telephony 1.0.0 26/05/2021 13:02 RD003 - API_Integration

https://[server]:[port]/telephonyapi/api/telephony/getrecording
Summary Returns URL with the recording associated to the given call guid.
Type POST
Header Content-Type application/json
Parameters data {
"guid": "8cb45c39-9f76-497e-bc49-
5ed5504d6765"
}
Returns HTTP status 403: f orbidden indicates that the server ref uses to f ulf ill
the request.
HTTP status 500: InternalServerError indicates that a generic error
has occurred on the server
HTTP status 200: OK indicates that the request succeeded and an
URL: https://127.0.0.1/telephonyapi/recordings/ 8cb45c39-9f76-
497e-bc49-5ed5504d6765.wav

https://[server]:[port]/telephonyapi/api/telephony/searchcall
Summary Retrieves calls guids.
Type POST
Header Content-Type application/json
Parameters data {
"called": "912345678",
"caller": "123",
"startDate": "20380926 10:24:34",
"endDate": "20380926 10:34:34" //date
format: yyyyMMdd HH:mm:ss
}
Returns HTTP status 403: f orbidden indicates that the server ref uses to f ulf ill
the request.
HTTP status 500: InternalServerError indicates that a generic error
has occurred on the server
HTTP status 200: OK indicates that the request succeeded and a list
of additional data:
[{"guid": "abc45c39-9f76-497e-bc49-5ed5504d6765"},
{"guid": "bac45c39-9f76-497e-bc49-5ed5504d6765"}]

https://[server]:[port]/telephonyapi/api/telephony/hangup
Summ Hungs up an extension with the generated GUID in .
ary
Type POST
Header Content-Type application/json
Param data {
eters "from": "131",
"agtRef": "AGB",
"guid": "a902348d-a7fe-427e-899b-
8c2674ff7f81"
}
Return HTTP status 403: f orbidden indicates that the server ref uses to f ulf ill the
s request.
HTTP status 500: InternalServerError indicates that a generic error has
occurred on the server

© 2021 JUSAN S.A. Página 6

 Project Request by Request Date
Fidelity Api - Telephony Jusan S.A. 26/09/2018

Doc Reference Doc version Last Saved Time Doc Type

API_FID_Telephony 1.0.0 26/05/2021 13:02 RD003 - API_Integration

HTTP status 200: OK indicates that the request succeeded and returns
current call inf ormation:
{
"Guid": "8cb45c39-9f76-497e-bc49-5ed5504d6765",
"CTICallId": "65972",
"CalledPhone": "163",
"EndTime": "2018-07-11T12:23:05.89",
"Duration": "0",
"Result": "TALKING",
"RefAgent": null,
"RecordFile":
"c:\\recordings\\20180323\\B$SIPDED2$anonymous$37167066600$DED2$3K1_T
ELEPHONY$10d07m2018y$10h05m41s$0a7In",
"Type": "OUTGOING"
}

© 2021 JUSAN S.A. Página 7