Genesys Integration
Endpoint: /api/contacts/incontact/create
/api/contacts/incontact/createFull URL: {base_url}/api/contacts/incontact/create
Method
GET
Authentication
Required: Yes. Requires a user to be logged in to CS Contact, and have a CS Contact role that has the "Manage Contact" permission
Query Parameters
ivrId
string
Yes
Genesys system identifier
queue
string
Yes
Queue code used to find the contact source
agent
string
Yes
Agent identifier
ani
string
No
Automatic Number Identification (caller's phone number)
dnis
string
No
Dialed Number Identification Service (number that was dialed)
mediatype
string
No
InContact media type code. Default: '4' (Call). Valid values: '1' (Email), '2' (Fax), '3' (Chat), '4' (Call), '5' (VoiceMail), '6' (WorkItem), '7' (SMS), '8' (Social), '9' (Digital)
Changes or additions to this mapping can be configured in CS Contact Admin Dashboard
postalcode
string
No
Postal/ZIP code
p
string
No
Additional Parameter
Behavior
Validation:
Validates required fields:
ivrId,queue,agentThrows
BadRequestExceptionwith validation errors if invalid
Contact Source Resolution:
Uses
queueparameter to find the contact source by codeLooks up contact source in the agent's organization
Sets
sourcein the payload if contact source is found
Media Type Mapping:
Maps
mediatypecodes toMediumTypesenum:'1'→Email'2'→Fax'3'→Chat'4'→Call(default)'5'→Voice Mail'6'→Work Item'7'→SMS'8'→Social'9'→Digital
Defaults to
Callifmediatypeis not recognized
Contact Creation:
Creates a Contact, and
Maps
mediatypetomediumStores all query parameters in
ivrDataResolves contact source from
queuecode
Response:
Type: HTTP Redirect (302)
Location:
/contacts/{contactId}(where{contactId}is the UUID of the created contact)Note: This is a redirect response, not JSON
Example Request
Example Response
Last updated
Was this helpful?