Sign in
FlexV1InteractionChannelInvite

Invite an Agent or a TaskQueue to a Channel.

Invite an Agent or a TaskQueue to a Channel.

post/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Invites

Path parameters

InteractionSidstring required

The Interaction SID for this Channel.

ChannelSidstring required

The Channel SID for this Invite.

Response

OK

sidstring nullable

The unique string created by Twilio to identify an Interaction Channel Invite resource.

interaction_sidstring nullable

The Interaction SID for this Channel.

channel_sidstring nullable

The Channel SID for this Invite.

{"stackTrail":"components:schemas:flex.v1.interaction.interaction_channel.interaction_channel_invite: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

Changes

Changed in 4 of the 51 revisions of this API.43

  • v105805a8f9c8511See the full diff
    • ▲

      removed the success response with the status

      response-success-status-removed

    • ○

      added the success response with the status

      response-success-status-added

  • v10e4cd336d78a11See the full diff
    • ▲

      the response's property type changed from object to no type for status

      response-property-type-changed

    • ○

      the request property type was generalized from object to no type

      request-property-type-generalized

  • v165f781b3f6b12See the full diff
    • ▲

      the request property type changed from no type to object

      request-property-type-changed

    • ▲

      the response's property type changed from no type to object for status

      response-property-type-changed

  • v1c37c20a0a1cb1See the full diff
    • ○

      api tag FlexV1InteractionChannelInvite added

      api-tag-added