Skip to main content

Samsung Bixby Inputs

Run in Postman

Input message with userId

The input message type represents a message sent by the user in a text format. It can contain plain text or various formatting options.

Please refer to input objects in Samsung Bixby's documentation.

curl --include \
--request POST \
--header "Authorization: Token BOTANALYTICS_CHANNEL_TOKEN" \
--header "Content-Type: application/json"
--data "{
   'messages': [
      {
         'message': {
           
         }
      }
   ]
}" \
https://api.beta.botanalytics.co/v2/messages

Field Descriptions

  • messages (array): An array containing messages.
    • message (object): Represents an individual message.
      • timestamp (number): The timestamp (in milliseconds) of the input.

Please note that the message object within messages array above has the Bixby's native input format plus timestamp field which is required for each message object.

Example of single message payload in JSON format

{
  "messages": [
    {
      "message": {
        "timestamp": 1458692752478,
        "inputs": {
            "searchTerm": "fruits"
        },
        "intent": "test",
        "$vivContext": {
            "canTypeId": "bixby-mobile-en-US",
            "device": "bixby-mobile",
            "userId": "u1",
            "locale": "en-US",
            "timezone": "America/Los_Angeles",
            "testToday": null,
            "accessToken": null,
            "svcId": null,
            "rampcode": null,
            "conversationId": null,
            "requestId": null,
            "sessionId": "0a8ff565bfbace92f7739f521824d15816f056588af43205415984598d0aebfd",
            "handsFree": false,
            "storeCountry": "",
            "deviceModel": "",
            "productCode": null,
            "screenLocked": false,
            "utterance": null,
            "clientAppId": null,
            "clientAppVersion": null,
            "drivingMode": false,
            "grantedPermissions": {},
            "is24HourFormat": false,
            "bixbyUserId": null,
            "allowLockScreenExecution": false
        }
      }
    }
  ]
}

Example of multiple messages payload in JSON format

{
  "messages": [
    {
      "message": {
        "timestamp": 1458692752478,
        "inputs": {
            "searchTerm": "fruits"
        },
        "intent": "test",
        "$vivContext": {
            "canTypeId": "bixby-mobile-en-US",
            "device": "bixby-mobile",
            "userId": "u1",
            "locale": "en-US",
            "timezone": "America/Los_Angeles",
            "testToday": null,
            "accessToken": null,
            "svcId": null,
            "rampcode": null,
            "conversationId": null,
            "requestId": null,
            "sessionId": "0a8ff565bfbace92f7739f521824d15816f056588af43205415984598d0aebfd",
            "handsFree": false,
            "storeCountry": "",
            "deviceModel": "",
            "productCode": null,
            "screenLocked": false,
            "utterance": null,
            "clientAppId": null,
            "clientAppVersion": null,
            "drivingMode": false,
            "grantedPermissions": {},
            "is24HourFormat": false,
            "bixbyUserId": null,
            "allowLockScreenExecution": false
        }
      }
    },
    {
      "message": {
        "timestamp": 1458692752600,
        "inputs": {
            "searchTerm": "show me movies"
        },
        "intent": "search_movies",
        "$vivContext": {
            "canTypeId": "bixby-mobile-en-US",
            "device": "bixby-mobile",
            "userId": "u1",
            "locale": "en-US",
            "timezone": "America/Los_Angeles",
            "testToday": null,
            "accessToken": null,
            "svcId": null,
            "rampcode": null,
            "conversationId": null,
            "requestId": null,
            "sessionId": "0a8ff565bfbace92f7739f521824d15816f056588af43205415984598d0aebfd",
            "handsFree": false,
            "storeCountry": "",
            "deviceModel": "",
            "productCode": null,
            "screenLocked": false,
            "utterance": null,
            "clientAppId": null,
            "clientAppVersion": null,
            "drivingMode": false,
            "grantedPermissions": {},
            "is24HourFormat": false,
            "bixbyUserId": null,
            "allowLockScreenExecution": false
        }
      }
    }
  ]
}

Input message with bixbyUserId

The input message type represents a message sent by the user in a text format. It can contain plain text or various formatting options.

Example of single message payload in JSON format

{
  "messages": [
    {
      "message": {
        "timestamp": 1458692752478,
        "inputs": {
            "searchTerm": "fruits"
        },
        "intent": "test",
        "$vivContext": {
            "canTypeId": "bixby-mobile-en-US",
            "device": "bixby-mobile",
            "bixbyUserId": "u1",
            "locale": "en-US",
            "timezone": "America/Los_Angeles",
            "testToday": null,
            "accessToken": null,
            "svcId": null,
            "rampcode": null,
            "conversationId": null,
            "requestId": null,
            "sessionId": "0a8ff565bfbace92f7739f521824d15816f056588af43205415984598d0aebfd",
            "handsFree": false,
            "storeCountry": "",
            "deviceModel": "",
            "productCode": null,
            "screenLocked": false,
            "utterance": null,
            "clientAppId": null,
            "clientAppVersion": null,
            "drivingMode": false,
            "grantedPermissions": {},
            "is24HourFormat": false,
            "allowLockScreenExecution": false
        }
      }
    }
  ]
}

Example of multiple messages payload in JSON format

{
  "messages": [
    {
      "message": {
        "timestamp": 1458692752478,
        "inputs": {
            "searchTerm": "fruits"
        },
        "intent": "test",
        "$vivContext": {
            "canTypeId": "bixby-mobile-en-US",
            "device": "bixby-mobile",
            "bixbyUserId": "u1",
            "locale": "en-US",
            "timezone": "America/Los_Angeles",
            "testToday": null,
            "accessToken": null,
            "svcId": null,
            "rampcode": null,
            "conversationId": null,
            "requestId": null,
            "sessionId": "0a8ff565bfbace92f7739f521824d15816f056588af43205415984598d0aebfd",
            "handsFree": false,
            "storeCountry": "",
            "deviceModel": "",
            "productCode": null,
            "screenLocked": false,
            "utterance": null,
            "clientAppId": null,
            "clientAppVersion": null,
            "drivingMode": false,
            "grantedPermissions": {},
            "is24HourFormat": false,
            "bixbyUserId": null,
            "allowLockScreenExecution": false
        }
      }
    },
    {
      "message": {
        "timestamp": 1458692752600,
        "inputs": {
            "searchTerm": "show me movies"
        },
        "intent": "search_movies",
        "$vivContext": {
            "canTypeId": "bixby-mobile-en-US",
            "device": "bixby-mobile",
            "bixbyUserId": "u1",
            "locale": "en-US",
            "timezone": "America/Los_Angeles",
            "testToday": null,
            "accessToken": null,
            "svcId": null,
            "rampcode": null,
            "conversationId": null,
            "requestId": null,
            "sessionId": "0a8ff565bfbace92f7739f521824d15816f056588af43205415984598d0aebfd",
            "handsFree": false,
            "storeCountry": "",
            "deviceModel": "",
            "productCode": null,
            "screenLocked": false,
            "utterance": null,
            "clientAppId": null,
            "clientAppVersion": null,
            "drivingMode": false,
            "grantedPermissions": {},
            "is24HourFormat": false,
            "bixbyUserId": null,
            "allowLockScreenExecution": false
        }
      }
    }
  ]
}