Go!Vid
Generate a session
Go!Vid
Generate a session
POST
/
api
/
v1
/
session
{
"scenario_code": "default"
"language": "fr-FR"
"external_id": 123, // i.e your customer_ref
"input_data": {
"firstname": "Customer firstname",
"lastname": "Customer lastname",
"phone": "+352521000000",
"birthdate": "YYYY-MM-DD",
"address": "TestAddress",
"zip": "TestZip",
"country": "TestCountry",
"city": "TestCity"
}
}
{
"session_id": "d897374f-6458-4781-b4ec-cfb192297d6a",
"customer_reference": "123",
"start_date": 1516975975
}
Request
Content-Type: application/json
| Parameter | Type | Description |
|---|---|---|
scenario_code | string | Required. Scenario to be used for this session |
language | string | Required. Language to be used for this session, must be enabled in the scenario |
external_id | string | Optional. Your customer reference, if not defined an orphan session will be created |
input_data | object | Optional. Customer data to be used for this session, see ‘input_data’ reference |
Response
Content-Type: application/json
| Parameter | Type | Description |
|---|---|---|
session_id | string | Session ID |
customer_reference | string | Customer reference |
start_date | int | Session start date in unix timestamp format |
{
"scenario_code": "default"
"language": "fr-FR"
"external_id": 123, // i.e your customer_ref
"input_data": {
"firstname": "Customer firstname",
"lastname": "Customer lastname",
"phone": "+352521000000",
"birthdate": "YYYY-MM-DD",
"address": "TestAddress",
"zip": "TestZip",
"country": "TestCountry",
"city": "TestCity"
}
}
{
"session_id": "d897374f-6458-4781-b4ec-cfb192297d6a",
"customer_reference": "123",
"start_date": 1516975975
}