Overview and Request Content
- PDF
Overview and Request Content
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
EasySend Agent Interfaces are typically used by agents and customer services representatives, to initiate digital processes for a customer.
This API is used to generate a link to an EasySend Agent Interface that can be prefilled with information. The created link will contain a unique request ID that ensures all prefilled data is embedded in the link.
URL Path
player/api/generate-global-agent-link
Method
A POST request should be performed with the following HTTP Header: Content-Type: application/json.
Authentication Using apiKey Field
The apiKey allows EasySend to use a simple authentication mechanism that is used to authenticate the client against the server. The apiKey must be passed with every API call.
Warning!
Your apiKey is private and should always be kept secret. Never share your API key with a 3rd party. Always trigger EasySend APIs from a server-side application. Avoid embedding your API key in a client-side / web-based application.
Request Content
Table 1 describes the required request content parameters.
Table 1: Request Content
| Parameter | Type | Optional/Required | Discerption |
| apiVersion | integer | Required | The API version |
| apiKey | string | Required | The API key for the provided environment |
| customerId | string | Required | An rid of an active request, as returned from /generate-link |
| processId | string | Required | As given by EasySend |
| agentData | object | Required | The unique id of the process |
| linkType | string | Optional |
|
| tlink | integer | Optional |
|
| agentGroup | string | Optional | As defined in Global Agent configuration under Manage Agent Groups (Bottom left) |
| source | string | Optional | Set the source field in the Agent Interface metadata |
| cobrowsingEnabled | boolean | Optional |
|
| processSerializedModel | object | Optional | All the model fields of the target digital process that will be triggered |
Return Value
The HTTP status code will determine the success/failure of the response. The return code 200 is a success, and any other return code is considered an error.
A successful request will contain a JSON request body as follows:
{
“link”: <generated link to EasySend form>
}Was this article helpful?