PBX

• Genesys
  • postCreating interactions
  • postUpdate interactions
  • postCreating interactions for campaign

API docs by Redocly

YetiForce API for PBX. Type: PBX (0.1)

Download OpenAPI specification:Download

Devs API Team: devs@yetiforce.com URL: https://yetiforce.com/ License: YetiForce Public License Terms of Service

Platform API Interactive Docs

Genesys

Creating interactions

Register interaction.

Authorizations:

ApiKeyAuth

Request Body schema: application/json

required

Contents of the request contains an associative array with the data.

GenesysIDInteraction required	string
OutboundCallID	integer
QueueName	string
QueueTime	integer
ServiceType	string
ServiceValue	string
DialedNumber	string
CustomerEmail	string
CustomerPhoneNumber	string
FacebookActorID	string
FacebookActorName	string
CustomerContactName	string
CustomerContactLastName	string
CustomerNIP	integer
CustomerAgreements	string
AgentName	string
AgentID	string
MediaType required	string Enum: "voice in" "voice out" "callback" "chat" "InboundNew" "email out" "email in" "outbound" "messenger" "facebook" "facebookprivatemessage"
CRMPreviewInteractionID	string
InteractionStartDateTime required	string
CRMSourceID	integer

Responses

Demo server of the development version

https://gitdeveloper.yetiforce.com/webservice/PBX/GenesysWdeWhirly/registerInteraction

Demo server of the latest stable version

https://gitstable.yetiforce.com/webservice/PBX/GenesysWdeWhirly/registerInteraction

Request samples

• Payload

Content type

application/json

{

• "GenesysIDInteraction": "00047aHK833X02TB",
• "OutboundCallID": 0,
• "QueueName": "string",
• "QueueTime": 122,
• "ServiceType": "string",
• "ServiceValue": "string",
• "DialedNumber": "string",
• "CustomerEmail": "test@yetiforce.com",
• "CustomerPhoneNumber": "+48884998123",
• "FacebookActorID": "4187643884658211",
• "FacebookActorName": "string",
• "CustomerContactName": "Tom",
• "CustomerContactLastName": "Kowalski",
• "CustomerNIP": 0,
• "CustomerAgreements": "[]",
• "AgentName": "string",
• "AgentID": "string",
• "MediaType": "voice in",
• "CRMPreviewInteractionID": "string",
• "InteractionStartDateTime": "2022-11-08T14:54:55.9895353Z",
• "CRMSourceID": 4475

}

Response samples

• 200
• 500

Content type

application/json

{

• "status": 1,
• "interactionId": 3345,
• "url": "https://gitstable.yetiforce.com/index.php?module=Accounts&view=List"

}

Update interactions

Update interaction.

Authorizations:

ApiKeyAuth

Request Body schema: application/json

required

Contents of the request contains an associative array with the data.

GenesysIDInteraction required	string
InteractionEndDateTime required	string
InteractionHandleTime	integer
DispositionCode	string
AgentName	string
TransferAgentID	string
TransferAgentName	string
CallResult required	string
PersonalCallback	integer
CRMInteractionID	integer
AgentID required	string
CRMPreviousInteractionID	integer
StatusInteraction	string
SessionID required	string

Responses

Demo server of the development version

https://gitdeveloper.yetiforce.com/webservice/PBX/GenesysWdeWhirly/updateInteraction

Demo server of the latest stable version

https://gitstable.yetiforce.com/webservice/PBX/GenesysWdeWhirly/updateInteraction

Request samples

• Payload

Content type

application/json

{

• "GenesysIDInteraction": "00016aFW01KD009T",
• "InteractionEndDateTime": "2022-10-18T12:55:09.3474109Z",
• "InteractionHandleTime": 90,
• "DispositionCode": "string",
• "AgentName": "string",
• "TransferAgentID": "string",
• "TransferAgentName": "string",
• "CallResult": "ended",
• "PersonalCallback": 0,
• "CRMInteractionID": 0,
• "AgentID": "string",
• "CRMPreviousInteractionID": 0,
• "StatusInteraction": "string",
• "SessionID": "00QG8R2EQS9KT6Q31M0AHG5AES00001P"

}

Response samples

• 200
• 500

Content type

application/json

{

• "status": 1

}

Creating interactions for campaign

Register interaction campaign.

Authorizations:

ApiKeyAuth

Request Body schema: application/json

required

Contents of the request contains an associative array with the data.

MediaType	string Enum: "email" "sms"
ServiceType	string
ServiceValue	string
GenesysIDInteraction required	string
OutboundCallID	integer
DialedNumber	string
CustomerEMail	string
CustomerNIP	integer
TemplateCRMID	integer
InteractionStartDateTime	string
InteractionEndDateTime required	string

Responses

Demo server of the development version

https://gitdeveloper.yetiforce.com/webservice/PBX/GenesysWdeWhirly/registerInteractionCampaign

Demo server of the latest stable version

https://gitstable.yetiforce.com/webservice/PBX/GenesysWdeWhirly/registerInteractionCampaign

Request samples

• Payload

Content type

application/json

{

• "MediaType": "email",
• "ServiceType": "string",
• "ServiceValue": "string",
• "GenesysIDInteraction": "03RGG833ANU72009",
• "OutboundCallID": 0,
• "DialedNumber": "string",
• "CustomerEMail": "string",
• "CustomerNIP": 0,
• "TemplateCRMID": 0,
• "InteractionStartDateTime": "2022-11-04 09:17:26",
• "InteractionEndDateTime": "2022-11-04 09:17:26"

}

Response samples

• 200
• 500

Content type

application/json

{

• "status": 1

}