Genesys Softphone Connector
Version: 2.0
Methods
POST /audio - Control audio devices
Control the available audio devices. You can mute/unmute the microphone or change the volume of the audio devices.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body devices (required)
Body Parameter —
Responses
200
OK
400
Bad Request
403
Forbidden
404
Not Found
DELETE /calls - Release an active call
Release an active call. This request should only be used in a disaster recovery situation if you need to delete false calls.
Responses
200
OK
400
Bad Request
403
Forbidden
404
Not Found
DELETE /register - Stop the SIP or WebRTC session
Stop the current SIP or WebRTC connection.
Responses
200
OK
400
Bad Request
403
Forbidden
404
Not Found
POST /register - Start a SIP or WebRTC session
Start a SIP or WebRTC connection. For WebRTC, this request provides the Softphone with the token used for OAuth authentication.
Responses
200
OK
400
Bad Request
403
Forbidden
404
Not Found
DELETE /session -Close session
Close the current session, which stops all SIP or WebRTC connections. Use this request when an agent logs out.
Responses
200
OK
400
Bad Request
403
Forbidden
404
Not Found
GET /session -Get session information
Get session information about the Softphone, including connections, calls and audio states.
Return type
Example data
Content-Type: application/json
{
"devices" : {
"speaker" : {
"volume" : 8,
"name" : "name",
"muted" : true
},
"microphone" : {
"volume" : 60,
"name" : "name",
"muted" : true
},
"headset_used" : true
},
"phone" : {
"local_mos" : 5.962134,
"rtt_ms" : 5,
"calls" : [ {
"state" : "UNKNOWN",
"uuid" : "uuid"
}, {
"state" : "UNKNOWN",
"uuid" : "uuid"
} ],
"vq_alarm_on" : true,
"local_inter_mos" : 1.4658129
},
"connectivities" : {
"protocol" : "udp",
"connections" : [ {
"server" : "server",
"state" : "NONE",
"user" : "user"
}, {
"server" : "server",
"state" : "NONE",
"user" : "user"
} ]
},
"status" : "INITIALIZING"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200
OK session
400
Bad Request
403
Forbidden
404
Not Found
POST /session -Update session
Update the current session with your configuration for the SIP Endpoint and Softphone options. Use this request once when your client application initializes.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body config (required)
Body Parameter —
Responses
200
OK
400
Bad Request
403
Forbidden
404
Not Found
Models
call
uuid (optional)
String The unique ID for the call. This ID comes from the "X-Genesys-CallUUID" header of the SIP session.
state (optional)
String The state of the call.
Enum:
UNKNOWN
ALETING
CONNECTED
DISCONNECTED
IN_PROGRESS
HELD
MEDIA_OFFER
OFFER_WAITING
MEDIA_ACCEPTED
MEDIA_REJECTED
RINGING
VQ_ALARM
VQ_ALARM_OFF
config
config_options
sipendpoint (optional)
Object Use this property to override Genesys Softphone options when provisioning the application. You must specify the option as For example, to override the ringing_file setting in the session section, configure policy.session.ringing_file in your application provisioning. See the options reference for a list of Genesys Softphone settings.
softphone (optional)
config_options_softphone
Configuration option specific to Softphone application.
session_expire (optional)
Integer The timeout, in seconds, for the Softphone to wait for the 'GetSession' service before ending the current session.
enforce_headset_usage (optional)
Boolean Specifies whether the SIP Endpoint must wait for the detection of the headset that is configured in the headset_name option before finalizing initialization. The agent remains logged out until the headset is detected.
username (optional)
String This property is used only for WebRTC connectivity for identifying current session.
connection
server (optional)
String For SIP Server, the format is . For SRV resolution, this property specifies the SRV record without including the port number in the server's URI.
user (optional)
String The DN for the agent.
state (optional)
String The state of the connection.
Enum:
NONE
STANDALONE
DISABLED
TRYING
FAILED
READY
SHUTDOWN
connectivities
protocol (optional)
String The protocol used for SIP (udp or tcp)or WebRTC (https) connections.
Enum:
udp
tcp
https
connections (optional)
array[connection] The Softphone's configured connections.
devices
headset_used (optional)
Boolean The value is true if the agent is using a headset.
speaker
microphone
devices_microphone
devices_speaker
phone
vq_alarm_on (optional)
Boolean The value is true if the Voice Quality alarm is on. This is only applicable if VQ is activated in the SIP Endpoint options.
local_inter_mos (optional)
Float The local Mean Opinion Score (MOS — a measure of reported network quality ratings) for the last interval. This is only applicable if VQ is activated in the SIP Endpoint options. format: float
local_mos (optional)
Float The local MOS for entire call segment. This is only applicable if VQ is activated in the SIP Endpoint options. format: float
rtt_ms (optional)
Integer The round-trip time in milliseconds. This is only applicable if VQ is activated in the SIP Endpoint options.
calls (optional)
session
status (optional)
String The Softphone status. INITIALIZING - The Softphone is waiting for connections to register and is not ready for phone calls. INITIALIZED - The Softphone is connected, configured, and ready for phone calls. WAITING_HEADSET - The Softphone is waiting to detect the agent's headset before registering connections.
Enum:
INITIALIZING
INITIALIZED
WAITING_HEADSET
connectivities (optional)
devices (optional)
phone (optional)