Skip to main content

Genesys v1.0

Api used to support functionality specific to Genesys Cloud and Engage integrations

info

You are viewing REST API documentation. This documentation is auto-generated from a swagger specification which itself is generated from annotations in the source code of the project. It is possible that this documentation includes bugs and that code samples are incomplete or wrong.

Authentication

Genesys Support Service

Api used to support functionality specific to Genesys Cloud and Engage integrations

Create a genesys callback (schedule)

POST https://auvious.video:443/security/genesys/callback HTTP/1.1
Host: auvious.video:443
Content-Type: application/json
Accept: application/json
X-OtpVerificationId: string
X-OtpCode: string
X-ApplicationId: string
X-UrlBase: string
X-Ticket-Expiration-Seconds: 0

Create a new genesys callback. Allowed with a valid otp code,verification id, or with client credentials. For request body schema check https://developer.genesys.cloud/api/rest/v2/conversations/#postConversationsCallbacks, with queueName added for convenience.

Request body

{
"callbackNumbers": [
"string"
],
"callbackScheduledTime": "string",
"callbackUserName": "string",
"countryCode": "string",
"data": {
"property1": "string",
"property2": "string"
},
"queueId": "string",
"queueName": "string",
"routingData": {
"languageId": "string",
"preferredAgentIds": [
"string"
],
"priority": 0,
"queueId": "string",
"queueName": "string",
"skillIds": [
"string"
]
},
"scriptId": "string",
"validateCallbackNumbers": true
}

Parameters

ParameterInTypeRequiredDescription
X-OtpVerificationIdheaderstringfalseonly for otp authentication
X-OtpCodeheaderstringfalseonly for otp authentication
X-ApplicationIdheaderstringtruemandatory, can be found at application settings page
X-UrlBaseheaderstringfalsemandatory when using client credentials, e.g. https://auvious.video
X-Ticket-Expiration-Secondsheaderinteger(int32)falseexpiration seconds for ticket url (since the scheduled time). 4 hours (14400) is the default
bodybodyCreateGenesysCallbackCommandfalsenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKCallbackResult
201CreatedCreatedNone
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
404Not FoundNot FoundNone
Examples

200 Response

{
"agentUrl": "string",
"conferenceId": "string",
"ticketId": "string",
"ticketUrl": "string"
}
caution

To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )

Code samples

curl -X POST https://auvious.video:443/security/genesys/callback \
-H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'X-OtpVerificationId: string' \ -H 'X-OtpCode: string' \ -H 'X-ApplicationId: string' \ -H 'X-UrlBase: string' \ -H 'X-Ticket-Expiration-Seconds: 0' \ -H 'Authorization: Bearer {access-token}'

Create room,ticket and return ticket and agent urls

POST https://auvious.video:443/security/genesys/room HTTP/1.1
Host: auvious.video:443
Content-Type: application/json
Accept: application/json

Create a new room, ticket and return the urls. Allowed from trusted clients that have authenticated using client credentials. Ticket url expires by default after 4 hours.

Request body

{
"applicationId": "string",
"cdestination": "callback",
"customerId": "string",
"interactionId": "string",
"organizationId": "string",
"ticketExpirationSeconds": 0,
"urlBase": "string"
}

Parameters

ParameterInTypeRequiredDescription
bodybodyCreateRoomWebCommandfalsenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKCreateRoomResult
201CreatedCreatedNone
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
404Not FoundNot FoundNone
Examples

200 Response

{
"agentUrl": "string",
"recordingUrl": "string",
"ticketUrl": "string"
}
caution

To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )

Code samples

curl -X POST https://auvious.video:443/security/genesys/room \
-H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'

Schemas

CallbackResult

{
"agentUrl": "string",
"conferenceId": "string",
"ticketId": "string",
"ticketUrl": "string"
}

CallbackResult

Properties

NameTypeRequiredRestrictionsDescription
agentUrlstringfalsenonea url for the agent to join
conferenceIdstringfalsenonethe id of the conference created
ticketIdstringfalsenonea ticket id which can be used to join the conference
ticketUrlstringfalsenonea url for the customer to join

CreateGenesysCallbackCommand

{
"callbackNumbers": [
"string"
],
"callbackScheduledTime": "string",
"callbackUserName": "string",
"countryCode": "string",
"data": {
"property1": "string",
"property2": "string"
},
"queueId": "string",
"queueName": "string",
"routingData": {
"languageId": "string",
"preferredAgentIds": [
"string"
],
"priority": 0,
"queueId": "string",
"queueName": "string",
"skillIds": [
"string"
]
},
"scriptId": "string",
"validateCallbackNumbers": true
}

CreateGenesysCallbackCommand

Properties

NameTypeRequiredRestrictionsDescription
callbackNumbers[string]falsenonephone number(s) of customer
callbackScheduledTimestringfalsenoneThe scheduled date-time for the callback as an ISO-8601 string yyyy-MM-ddTHH:mm:ss.SSSZ
callbackUserNamestringfalsenonename of customer, which will be displayed on the agent workspace
countryCodestringfalsenonenone
dataobjectfalsenonenone
» additionalPropertiesstringfalsenonenone
queueIdstringfalsenoneId of queue where the callback will take place. You can omit this and use queueName if you find it difficult to locate the queue id.
queueNamestringfalsenoneCan be used instead of queueId, which is more convenient
routingDataRoutingDatafalsenonenone
scriptIdstringfalsenonenone
validateCallbackNumbersbooleanfalsenonenone

CreateRoomResult

{
"agentUrl": "string",
"recordingUrl": "string",
"ticketUrl": "string"
}

CreateRoomResult

Properties

NameTypeRequiredRestrictionsDescription
agentUrlstringfalsenonenone
recordingUrlstringfalsenonenone
ticketUrlstringfalsenonenone

CreateRoomWebCommand

{
"applicationId": "string",
"cdestination": "callback",
"customerId": "string",
"interactionId": "string",
"organizationId": "string",
"ticketExpirationSeconds": 0,
"urlBase": "string"
}

CreateRoomWebCommand

Properties

NameTypeRequiredRestrictionsDescription
applicationIdstringfalsenonewhich application to use
cdestinationstringfalsenonecdestination
customerIdstringfalsenonecustomer id, e.g. interaction or conversation id
interactionIdstringfalsenoneconversation/interaction id
organizationIdstringfalsenoneonly for access from internal service
ticketExpirationSecondsinteger(int32)falsenoneticket url expiration in seconds, 4 hours if not defined.
urlBasestringfalsenonewhich url base to use, e.g. https://auvious.video
Enumerated Values
PropertyValue
cdestinationcallback
cdestinationembedded
cdestinationpremise
cdestinationstandalone

RoutingData

{
"languageId": "string",
"preferredAgentIds": [
"string"
],
"priority": 0,
"queueId": "string",
"queueName": "string",
"skillIds": [
"string"
]
}

RoutingData

Properties

NameTypeRequiredRestrictionsDescription
languageIdstringfalsenonenone
preferredAgentIds[string]falsenonenone
priorityinteger(int32)falsenonenone
queueIdstringfalsenonenone
queueNamestringfalsenonenone
skillIds[string]falsenonenone