Action 80: Create Spribe Free Spin Reward Event
Function Description
- Please make sure to implement Free Spin Reward (Action 16) in order for the prize distribution to function properly.
- This action is dedicated to the Spribe game provider and can only be used to create a free spin reward event on a Spribe game.
- One request creates a free spin reward event for one player (
uid) on one Spribe game (machineType). - The free spin reward event cannot be modified after creation.
endTimemust be later than the current time.eventIdmust be a valid UUID v4 format (8-4-4-4-12hexadecimal characters). It is used as the idempotency key:- If the same
eventIdis sent again and the previous request has already created the event successfully, the system will not create a duplicate event and will return the originaleventId. - If the previous request with the same
eventIddid not complete successfully, the system will create the event with thiseventIdand return it.
- If the same
machineTypemust be a valid game of the Spribe provider and must be available to the requesting agent.- A successful response returns the
eventIdof the created event.
Parameter
| Parameter | Format | Mandatory | Description |
|---|---|---|---|
| action | Integer | Y | 80 |
| ts | Long | Y | Current system time |
| parent | String(50) | Y | Agent ID |
| eventId | String(36) | Y | Free Spin Reward Event Identifier (UUID v4 format, e.g. 550e8400-e29b-41d4-a716-446655440000)Used as the idempotency key. If the same eventId is reused and the event was already created successfully, no new event will be created and the same eventId will be returned. |
| name | String(70) | Y | Free Spin Reward Name |
| machineType | Integer | Y | Machine Type (must be a Spribe game) See Game List (4.2) in appendix |
| uid | String | Y | Player ID who will receive the free spin reward |
| bet | String | N | Free Spin Reward Bet Amount per Spin. Supports up to 3 decimal places. |
| times | Integer | N | Free Spin Reward TimesThe maximum allowed value is 999. |
| startTime | String | Y | Free Spin Reward Event Start Time (Only conforming to the following format in ISO-8601) yyyy-MM-ddTHH:mm:ss.sss+|-hh:mm |
| endTime | String | Y | Free Spin Reward Event End Time (Only conforming to the following format in ISO-8601) yyyy-MM-ddTHH:mm:ss.sss+|-hh:mm |
Example
{
"action": 80,
"ts": 1711555200000,
"parent": "testag",
"eventId": "550e8400-e29b-41d4-a716-446655440000",
"name": "TEST SPRIBE EVENT NAME",
"machineType": 22001,
"uid": "player1",
"bet": "2.000",
"times": 10,
"startTime": "2024-07-22T04:05:33.000+01:00",
"endTime": "2024-07-22T23:59:59.000+01:00"
}Return Results
| Parameter | Format | Description |
|---|---|---|
| status | String(4) | Success: 0000 Error: See Error Codes in Appendix |
| data | String | The eventId of the created free spin reward event |
| err_text | String(255) | Error message |
Operation Sample
// Http Request
http://{API_Address}/apiRequest.do?dc=jb1&x=y1wayxScczy6ABfElfaVwb5CdfHxBN_JGtxyBSvpohLQakP8M2QSetJNojJBzvnrVChhq8YWWgBTdGeXFTH4vSNQQ66epf4NqYeQ-6bJ15pvHctQjQevulv7GHqOifuju_gY0H54FfVdQc9D5tKh1AZ-9KDh9dwcGSszZxU7JOOoHdYITlCO5LhvGmHxPBwZ
// Http Response (success)
{
"status": "0000",
"data": "550e8400-e29b-41d4-a716-446655440000"
}
// Http Response (failed)
1. If necessary parameters are not provided or do not meet the requirement, for example: name, then:
{
"status": "8000",
"err_text": "The parameter of input error, please check your parameter is correct or not. parameter:name is required"
}
2. If machineType is not a Spribe game:
{
"status": "8000",
"err_text": "The parameter of input error, please check your parameter is correct or not. parameter:machineType must be a valid Spribe game"
}Last updated on