Jump to: navigation, search

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 Parameter — devices (required)

Responses

Code Reason
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

Code Reason
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

Code Reason
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

Code Reason
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

Code Reason
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

session

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

Code Reason Value
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 Parameter — config (required)

Responses

Code Reason
200 OK
400 Bad Request
403 Forbidden
404 Not Found


Models

call

Property Type Required Description
uuid String No The unique ID for the call. This ID comes from the "X-Genesys-CallUUID" header of the SIP session.
state String No The state of the call. Possible values are:
  • UNKNOWN
  • ALETING
  • CONNECTED
  • DISCONNECTED
  • IN_PROGRESS
  • HELD
  • MEDIA_OFFER
  • OFFER_WAITING
  • MEDIA_ACCEPTED
  • MEDIA_REJECTED
  • RINGING
  • VQ_ALARM
  • VQ_ALARM_OFF

config

Property Type Required Description
options config_options No Configuration options for the Softphone application.
connectivities connectivities No The connections and protocols associated with this call.

config_options

Property Type Required Description
sipendpoint Object No Use this property to override Genesys Softphone options when provisioning the application. You must specify the option as <domain>.<section>.<setting> 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 config_options_softphone No Configuration options specific to Softphone application.

config_options_softphone

Property Type Required Description
session_expire Integer No The timeout, in seconds, for the Softphone to wait for the 'GetSession' service before ending the current session.
enforce_headset_usage Boolean No 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 String No This property is used only for WebRTC connectivity for identifying current session.

connection

Property Type Required Description
server String No For SIP Server, the format is <sipServerName>:<sipServerPort>. For SRV resolution, this property specifies the SRV record without including the port number in the server's URI.
user String No The DN for the agent.
state String No The state of the connection. Possible values are:
  • NONE
  • STANDALONE
  • DISABLED
  • TRYING
  • FAILED
  • READY
  • SHUTDOWN

connectivities

Property Type Required Description
protocol String No The protocol used for SIP (udp or tcp) or WebRTC (https) connections.
connections array[connection] No The Softphone's configured connections.

devices

Property Type Required Description
headset_used Boolean No The value is true if the agent is using a headset.
devices_speaker devices_speaker No The speaker associated with the device.
microphone devices_microphone No The microphone associated with the device.

devices_microphone

Property Type Required Description
name String No The microphone device name.
volume Integer No The microphone volume.
muted Boolean No Specifies whether the microphone is muted.

devices_speaker

Property Type Required Description
name String No The speaker device name.
volume Integer No The speaker volume.
muted Boolean No Specifies whether the speaker is muted.

phone

Property Type Required Description
vq_alarm_on Boolean No 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 Float No 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.
local_mos Float No The local MOS for the entire call segment. This is only applicable if VQ is activated in the SIP Endpoint options.
rtt_ms Integer No The round-trip time in milliseconds. This is only applicable if VQ is activated in the SIP Endpoint options.
calls array[call] No The calls associated with this phone.

session

Property Type Required Description
status String No The Softphone status. Possible values ares:
  • 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.
connectivities connectivities No The connections and protocols associated with this session.
devices devices No The devices associated with this session.
phone phone No The phone associated with this session.
This page was last edited on November 18, 2019, at 14:47.

Feedback

Comment on this article:

blog comments powered by Disqus