Engage

Engage Genagent in a conversation.

post/mg-genagent/v1/engage

Request

Base URL
https://api.sandbox.asapp.com
Auth
API key in header asapp-api-id and API key in header asapp-api-secret
TypeScript
https://skmtc.dev/asapp/apis/mg-genagent-api-router/docs/mg-genagent/v1/engage/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namespace'amazonconnect' required

Namespace for media gateway

guidstring required

Globally Unique Id, also sometimes called Unique Call Id (UCID). Must be in decimal form.

language'en-US'

Language of the conversation, defaults to en-US.

inputVariablesobject

Input variables to be used as context in the analysis.

customerIdstring required

Id of the customer on the call. Usually taken from Call Center CTI information.

Example request

{
  "namespace": "amazonconnect",
  "guid": "704848f2-96c3-47cc-96d3-47ce6e1d8391",
  "customerId": "mycustomerid",
  "language": "en-US",
  "amazonConnectParams": {
    "streamArn": "arn:aws:kinesisvideo:us-east-1:<AWS account>:stream/streamtest-connect-asappconnect-contact-79270e2e-4b5e-4e37-8f28-43133f1b7b07/1696492311026"
  }
}

Response

Router processed the request, details are in the response body

Changes

No recorded changes to this operation across all 1 revision of this API.