Secure Email API

From Genesys Documentation
Jump to: navigation, search
This topic is part of the manual Genesys Multicloud CX Web-based API Reference for version Current of Developer.



Base path: /nexus/v3

GET
/securemail
Get secure emails
Get a list of secure emails for the specified email address.
Parameters
Name Default Description Parameter Type Data Type Required
address The email address of the consumer. query string true
status all Specifies the status of emails to count - unread, read or all (both read and unread). query string
index 0 The start index the API should use to get emails. query integer
count 10 The number of secure emails the API returns. query integer
securebox <empty> Securebox name. Allows to specify optional securebox name to send email to or read from. securebox provides ability to communicate with the same contact within several different departments independently. (contains only A-Z, a-z, 0-9, and must be from 3 to 16 characters long) query string
x-api-key A unique key required to use the API. If you do not already have this API key, contact your Customer Care representative. header string true
Responses
Code Reason
200 Ok 
{}
listSecureMailResponse
referenceId (referenceId):
operationId (operationId):
status (status):
data (ArrayOfSecureMail):
status
code (string):

Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE

message (string):

Status message.

detail (string):

Additional information.

genericResponse
referenceId (referenceId):
operationId (operationId):
status (status):
400 Invalid request parameters provided. 
{
  "referenceId": {
  },
  "operationId": {
  },
  "status": {
    "code": "string",
    "message": "string",
    "detail": "string"
  }
}
status
code (string):

Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE

message (string):

Status message.

detail (string):

Additional information.

genericResponse
referenceId (referenceId):
operationId (operationId):
status (status):
404 Entity with specified ID not found. 
{
  "referenceId": {
  },
  "operationId": {
  },
  "status": {
    "code": "string",
    "message": "string",
    "detail": "string"
  }
}
status
code (string):

Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE

message (string):

Status message.

detail (string):

Additional information.

genericResponse
referenceId (referenceId):
operationId (operationId):
status (status):
500 Server error occurred. 
{
  "referenceId": {
  },
  "operationId": {
  },
  "status": {
    "code": "string",
    "message": "string",
    "detail": "string"
  }
}
status
code (string):

Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE

message (string):

Status message.

detail (string):

Additional information.

genericResponse
referenceId (referenceId):
operationId (operationId):
status (status):
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/nexus/v3/securemail?address=string&status=string&index=0&count=0&securebox=string"
POST
/securemail
Send secure email
Send a secure email. The email is delivered to Genesys as a web form and routed as a standard email.
Parameters
Name Default Description Parameter Type Data Type Required
securebox <empty> Securebox name. Allows to specify optional securebox name to send email to or read from. securebox provides ability to communicate with the same contact within several different departments independently. (contains only A-Z, a-z, 0-9, and must be from 3 to 16 characters long) query string
xxNAMExx A unique key required to use the API. If you do not already have this API key, contact your Customer Care representative. header string true
data body 
{object}
data
data (, optional):
operationId (operationId, optional):
Responses
Code Reason
200 Ok 
{}
createSecureMailResponse
referenceId (referenceId):
operationId (operationId):
status (status):
secureMailId (string):

The unique ID of the secure email. bff348eb-dd5f-47d6-bf96-0e75b8ecf7ca

selfUri (string):
status
code (string):

Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE

message (string):

Status message.

detail (string):

Additional information.

genericResponse
referenceId (referenceId):
operationId (operationId):
status (status):
400 Invalid request parameters provided. 
{
  "referenceId": {
  },
  "operationId": {
  },
  "status": {
    "code": "string",
    "message": "string",
    "detail": "string"
  }
}
status
code

(string):

Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE
message (string):

Status message.

detail (string):

Additional information.

genericResponse
referenceId (referenceId):
operationId (operationId):
status (status):
500 Server error occurred. 
{
  "referenceId": {
  },
  "operationId": {
  },
  "status": {
    "code": "string",
    "message": "string",
    "detail": "string"
  }
}
status
code

(string):

Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE
message (string):

Status message.

detail (string):

Additional information.

genericResponse
referenceId (referenceId):
operationId (operationId):
status (status):
Usage
curl -X POST
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"
-d '{object}'
"https://api-demo.com/nexus/v3/securemail?securebox=string"
GET
/securemail/count
Get a count of unread, read or all secure emails
Get a count of unread, read or all secure emails for the specified email address.
Parameters
Name Default Description Parameter Type Data Type Required
address The email address of the consumer. query string true
status all Specifies the status of emails to count - unread, read or all (both read and unread). query string
securebox <empty> Securebox name. Allows to specify optional securebox name to send email to or read from. securebox provides ability to communicate with the same contact within several different departments independently. (contains only A-Z, a-z, 0-9, and must be from 3 to 16 characters long) query string
x-api-key A unique key required to use the API. If you do not already have this API key, contact your Customer Care representative. header string true
Responses
Code Reason
200 Ok 
{}
countSecureMailResponse
referenceId (referenceId):
operationId (operationId):
status (status):
data (object):
status
code (string):

Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE

message (string):

Status message.

detail (string):

Additional information.

genericResponse
referenceId (referenceId):
operationId (operationId):
status (status):
data
count (integer):

The count of secure emails of requested type for the contact. 20

400 Invalid request parameters provided. 
{
  "referenceId": {
  },
  "operationId": {
  },
  "status": {
    "code": "string",
    "message": "string",
    "detail": "string"
  }
}
status
code (string):

Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE

message (string):

Status message.

detail (string):

Additional information.

genericResponse
referenceId (referenceId):
operationId (operationId):
status (status):
404 Entity with specified ID not found. 
{
  "referenceId": {
  },
  "operationId": {
  },
  "status": {
    "code": "string",
    "message": "string",
    "detail": "string"
  }
}
status
code (string):

Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE

message (string):

Status message.

detail (string):

Additional information.

genericResponse
referenceId (referenceId):
operationId (operationId):
status (status):
500 Server error occurred. 
{
  "referenceId": {
  },
  "operationId": {
  },
  "status": {
    "code": "string",
    "message": "string",
    "detail": "string"
  }
}
status
code (string):

Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE

message (string):

Status message.

detail (string):

Additional information.

genericResponse
referenceId (referenceId):
operationId (operationId):
status (status):
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/nexus/v3/securemail/count?address=string&status=string&securebox=string"
GET
/securemail/{secureMailId}
Get secure email content
Get the content of a secure email.
Parameters
Name Default Description Parameter Type Data Type Required
read If set to true, the API changes the status to "read" for inbound and outbound emails and stops the inbound interaction from routing. query boolean
x-api-key A unique key required to use the API. If you do not already have this API key, contact your Customer Care representative. header string true
secureMailId The ID of the secure email. path string true
Responses
Code Reason
200 Ok 
{}
retrieveSecureMailResponse
referenceId

(referenceId):

operationId

(operationId):

status

(status):

secureMail

():

status
code (string):

Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE

message (string):

Status message.

detail (string):

Additional information.

genericResponse
referenceId (referenceId):
operationId (operationId):
status (status):
400 Invalid request parameters provided. 
{
  "referenceId": {
  },
  "operationId": {
  },
  "status": {
    "code": "string",
    "message": "string",
    "detail": "string"
  }
}
status
code (string):

Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE

message (string):

Status message.

detail (string):

Additional information.

genericResponse
referenceId (referenceId):
operationId (operationId):
status (status):
500 Server error occurred. 
{
  "referenceId": {
  },
  "operationId": {
  },
  "status": {
    "code": "string",
    "message": "string",
    "detail": "string"
  }
}
status
code (string):

Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE

message (string):

Status message.

detail (string):

Additional information.

genericResponse
referenceId (referenceId):
operationId (operationId):
status (status):
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/nexus/v3/securemail/{secureMailId}?read=true"
DELETE
/securemail/{secureMailId}
Mark as read or delete a secure email
Mark the secure email as read if the remove query parameter is either absent or set to 'read'. You can delete the secure email entirely if remove is set to 'purge'. To delete the secure email from the list of secure emails but keep it in the contact database, set remove to 'delete'.
Parameters
Name Default Description Parameter Type Data Type Required
remove read You can either mark a secure email as read, mark a secure email as deleted, or delete an email completely using the following values: * read - Mark the secure email as read. * true - Mark the secure email as read. (deprecated) * \<empty\> - Mark the secure email as read. (deprecated) * delete - Mark the secure email as deleted. The API will not return the email in requests to get the list of secure emails, but will keep it in the contact database. * purge - Delete the secure email from the list of emails and contact database. query string
x-api-key A unique key required to use the API. If you do not already have this API key, contact your Customer Care representative. header string true
secureMailId The ID of the secure email. path string true
Responses
Code Reason
200 Ok 
{}
retrieveSecureMailResponse
referenceId (referenceId):
operationId (operationId):
status (status):
secureMail ():
status
code (string):

Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE

message (string):

Status message.

detail (string):

Additional information.

genericResponse
referenceId (referenceId):
operationId (operationId):
status (status):
404 Entity with specified ID not found. 
{
  "referenceId": {
  },
  "operationId": {
  },
  "status": {
    "code": "string",
    "message": "string",
    "detail": "string"
  }
}
status
code (string):

Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE

message (string):

Status message.

detail (string):

Additional information.

genericResponse
referenceId (referenceId):
operationId (operationId):
status (status):
Usage
curl -X DELETE
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/nexus/v3/securemail/{secureMailId}?remove=string"
GET
/securemail/{secureMailId}/userdata
Get secure email userdata
Get the attached userdata of a secure email (some internal keys may be omitted).
Parameters
Name Default Description Parameter Type Data Type Required
x-api-key A unique key required to use the API. If you do not already have this API key, contact your Customer Care representative. header string true
secureMailId The ID of the secure email. path string true
Responses
Code Reason
200 Ok 
{}
retrieveSecureMailUserdataResponse
referenceId (referenceId):
operationId (operationId):
status (status):
data (object):

Interaction userdata.

status
code (string):

Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE

message (string):

Status message.

detail (string):

Additional information.

genericResponse
referenceId (referenceId):
operationId (operationId):
status (status):
400 Invalid request parameters provided. 
{
  "referenceId": {
  },
  "operationId": {
  },
  "status": {
    "code": "string",
    "message": "string",
    "detail": "string"
  }
}
status
code (string):

Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE

message (string):

Status message.

detail (string):

Additional information.

genericResponse
referenceId (referenceId):
operationId (operationId):
status (status):
500 Server error occurred. 
{
  "referenceId": {
  },
  "operationId": {
  },
  "status": {
    "code": "string",
    "message": "string",
    "detail": "string"
  }
}
status
code (string):

Error code of an operation. Valid Values: SUCCESS, FAILURE, INVALID_CLIENT_TOKEN, INVALID_CONTACT_CENTER, INVALID_SESSION, INVALID_PARTICIPANT, INVALID_TRANSPORT, INVALID_PARAMETER, INVALID_ENDPOINT, INVALID_NICKNAME, INVALID_FILE_TYPE

message (string):

Status message.

detail (string):

Additional information.

genericResponse
referenceId (referenceId):
operationId (operationId):
status (status):
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/nexus/v3/securemail/{secureMailId}/userdata?"
Retrieved from "https://all.docs.genesys.com/PEC-Developer/Current/WebAPIs/Secure_email (2024-04-28 10:37:22)"
Comments or questions about this documentation? Contact us for support!