Context on a Voice-API Integration

See : ‣,

Interfaçage API avec DialOnce

Prerequisites :

• A functional SMS-to-Bot integration (with voicePositionId).
• a voice-api token.

Requesting a contextualized SMS with a link to a bot

Following this api spec , make a first call to the initialization route to obtain a callId.

Include this callId in your call to the sms sending route:

{
  "callId": {string}, // Client caller UID
  "positionId": {string} // SVI position identifier
  "phoneNumber": {caller} // The caller phone number in E 164 format
  "context": { // the conversation's context
    "contextType": "myVeryFancyBot", // string that identifies the context's type, required for proper operation
    // custom content, any desired key/values
    "clientId": "12345678",
    "clientName": "John Doe"
    "randomNumber": 42069,
    // etc...
  } 
}

The context object in your payload should only contain character strings and numbers.