Sign in
playground

Create Session

Seed the scenario, then generate and send the opener out of band.

post/playground/sessions

Request body

phonestring required

Visitor's mobile number, any common US format

scenario_keystring required
consentboolean required

Visitor ticked the SMS consent box

Response

Successful Response

session_idstring required
statusstring required
scenario_keystring required
lanestring
expires_atstring date-time nullable
messagestring required

Changes

Changed in 3 of the 23 revisions of this API.212

  • c714e58b51561See the full diff
    • ●

      removed the request property

      request-property-removed

  • 94953390bbd81See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • db50150bcca521See the full diff
    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      response property expires_at list-of-types was widened by adding types null to media type application/json of response 202

      response-property-list-of-types-widened

    • ○

      added the optional property to the response with the status

      response-optional-property-added