Sign in
FlexV1Interaction

Create a new Interaction.

Create a new Interaction.

post/v1/Interactions

Response

OK

sidstring nullable

The unique string created by Twilio to identify an Interaction resource, prefixed with KD.

{"stackTrail":"components:schemas:flex.v1.interaction:properties:channel","oasType":"schema","type":"unknown","description":"A JSON object that defines the Interaction’s communication channel and includes details about the channel. See the [Outbound SMS](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#agent-initiated-outbound-interactions) and [inbound (API-initiated)](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#api-initiated-contact) Channel object examples.","nullable":true}
{"stackTrail":"components:schemas:flex.v1.interaction:properties:routing","oasType":"schema","type":"unknown","description":"A JSON Object representing the routing rules for the Interaction Channel. See [Outbound SMS Example](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#agent-initiated-outbound-interactions) for an example Routing object. The Interactions resource uses TaskRouter for all routing functionality. \n All attributes in the Routing object on your Interaction request body are added “as is” to the task. For a list of known attributes consumed by the Flex UI and/or Flex Insights, see [Known Task Attributes](https://www.twilio.com/docs/flex/developer/conversations/interactions-api#task-attributes).","nullable":true}
urlstring uri nullable
linksobject nullable
interaction_context_sidstring nullable
webhook_ttidstring nullable

Changes

Changed in 7 of the 51 revisions of this API.79

  • v105805a8f9c8511See the full diff
    • ▲

      removed the success response with the status 201

      response-success-status-removed

    • ○

      added the success response with the status 200

      response-success-status-added

  • v10e4cd336d78a22See the full diff
    • ▲

      the channel response's property type/format changed from object/ to / for status 201

      response-property-type-changed

    • ▲

      the routing response's property type/format changed from object/ to / for status 201

      response-property-type-changed

    • ○

      the Channel request property type/format was generalized from object/ to /

      request-property-type-generalized

    • ○

      the Routing request property type/format was generalized from object/ to /

      request-property-type-generalized

  • v12f0de8ff61252See the full diff
    • ○

      added the new optional request property WebhookTtid

      new-optional-request-property

    • ○

      added the optional property webhook_ttid to the response with the 201 status

      response-optional-property-added

  • v165f781b3f6b14See the full diff
    • ▲

      the Channel request property type/format changed from / to object/

      request-property-type-changed

    • ▲

      the Routing request property type/format changed from / to object/

      request-property-type-changed

    • ▲

      the channel response's property type/format changed from / to object/ for status 201

      response-property-type-changed

    • ▲

      the routing response's property type/format changed from / to object/ for status 201

      response-property-type-changed

  • v17e7d5d33e5821See the full diff
    • ○

      the request property Routing became optional

      request-property-became-optional

  • v1c37c20a0a1cb1See the full diff
    • ○

      api tag FlexV1Interaction added

      api-tag-added

  • v10a02afc7903e2See the full diff
    • ○

      added the new optional request property InteractionContextSid

      new-optional-request-property

    • ○

      added the optional property interaction_context_sid to the response with the 201 status

      response-optional-property-added