Do Box Creation [Say Box Activation/Subscription Process]
On ISayYouDo, end users subscribe or activate a service (Say Box) by creating a recipe (Do Box) through them. This recipe(Do Box) will consist of the user's preference in the In-Say Box and Out-Say Box of your service.
The creation and deletion of a Do Box (recipe) is handled by the In-End point and the Delete End point of your In Say Box.
EXECUTION PROCESS
When an I Say You Do user creates a do box, the data corresponding to both the In-Say Box and Out-Say Box will be saved and data will be forwarded to the corresponding in endpoint of the In-Say Box, immediately as a REST service call.
In endpoint request format (JSON) is as follows;
{
"activeStatus": 200,
"outputObject": {},
"outSequenceObject": {
"mobileNo": "9477XXXXXXX",
"message": "{result}"
},
"settingsObject": {},
"connectToken": "",
"inputObject": {
"filterCriteria": "Global Warming"
},
"sessionId": 123456,
"userId": 123
}
Parameter Details
Parameter Name | Description | Type |
---|---|---|
activeStatus | This parameter is always 200 in this scenario | Numeric |
inputObject | This JsonObject contains name value pairs generated from user given inputs, which are required for client side execution. (Please refer the UI Parameter mapping documentation for further details) | Jsonobject |
outputObject | Empty in this scenario | Jsonobject |
sessionId | Unique ID for the user recipe. This ID is sent to you when a user creates a recipe (Do Box) | Numeric |
UserId | Unique ID for the user | Numeric |
NOTE:
When an ISYD user creates a Do Box, it will make a service call to the In-say box’s endpoint. From the In-End point the activeStatus of this request should be changed to "1" and sent as a response. Without this change, the user will not be able to complete the Do Box creation process.
Refer the below code snippet from a sample in-end point application written in PHP
<?php
$data = json_decode(file_get_contents('php://input'));
$data->activeStatus = 1;
$json=json_encode($data);
echo $json;
?>
DELETION PROCESS
When an ISYD user deletes a do box, the data corresponding to the particular recipe(Do Box) will be saved and the data will be forwarded to the corresponding delete endpoint of the In-Say Box, immediately as a REST service call.
Delete endpoint request format (JSON) is as follows;
{
"activeStatus": 403,
"outputObject": {},
"outSequenceObject": {},
"settingsObject": {},
"inputObject": {},
"sessionId": 123456,
"userId": 0
}
Using this sessionId the developer shall be able to manage databases they may maintain of the user base.
Parameter Details
Parameter Name | Description | Type |
---|---|---|
activeStatus | This parameter is always 403 in this scenario | Numeric |
inputObject | Empty in this scenario | Jsonobject |
outputObject | Empty in this scenario | Jsonobject |
outSequenceObject | Empty in this scenario | Jsonobject |
sessionId | Unique ID for the user recipe. | Numeric |
UserId | Unique ID for the user which is 0 in the deletion scenario | Numeric |