/v1/Channels

/v1/Channels

• PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
• Page (query, page) — The page index. This value is simply for client state.
• PageToken (query) — The page token. This is provided by the API.

/v1/Channels/{Sid}

• Sid (path, required) — The SID of the Flex chat channel resource to delete.

/v1/Channels/{Sid}

• Sid (path, required) — The SID of the Flex chat channel resource to fetch.

/v1/Configuration

• UiVersion (query) — The Pinned UI version of the Configuration resource to fetch.

/v1/FlexFlows

• FriendlyName (query) — The `friendly_name` of the Flex Flow resources to read.
• PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
• Page (query, page) — The page index. This value is simply for client state.
• PageToken (query) — The page token. This is provided by the API.

/v1/FlexFlows

/v1/FlexFlows/{Sid}

• Sid (path, required) — The SID of the Flex Flow resource to delete.

/v1/FlexFlows/{Sid}

• Sid (path, required) — The SID of the Flex Flow resource to fetch.

/v1/FlexFlows/{Sid}

• Sid (path, required) — The SID of the Flex Flow resource to update.

/v1/Insights/Conversations

To get conversation with segment id

• Token (header) — The Token HTTP request header
• SegmentId (query) — Unique Id of the segment for which conversation details needs to be fetched
• PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
• Page (query, page) — The page index. This value is simply for client state.
• PageToken (query) — The page token. This is provided by the API.

/v1/Insights/QM/Assessments

Get assessments done for a conversation by logged in user

• Token (header) — The Token HTTP request header
• SegmentId (query) — The id of the segment.
• PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
• Page (query, page) — The page index. This value is simply for client state.
• PageToken (query) — The page token. This is provided by the API.

/v1/Insights/QM/Assessments

Add assessments against conversation to dynamo db. Used in assessments screen by user. Users can select the questionnaire and pick up answers for each and every question.

• Token (header) — The Token HTTP request header

/v1/Insights/QM/Assessments/Comments

To create a comment assessment for a conversation

• Token (header) — The Token HTTP request header
• SegmentId (query) — The id of the segment.
• AgentId (query) — The id of the agent.
• PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
• Page (query, page) — The page index. This value is simply for client state.
• PageToken (query) — The page token. This is provided by the API.

/v1/Insights/QM/Assessments/Comments

To create a comment assessment for a conversation

• Token (header) — The Token HTTP request header

/v1/Insights/QM/Assessments/{AssessmentId}

Update a specific Assessment assessed earlier

• AssessmentId (path, required) — The id of the assessment to be modified
• Token (header) — The Token HTTP request header

/v1/Insights/QM/Categories

To get all the categories

• Token (header) — The Token HTTP request header
• PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
• Page (query, page) — The page index. This value is simply for client state.
• PageToken (query) — The page token. This is provided by the API.

/v1/Insights/QM/Categories

To create a category for Questions

• Token (header) — The Token HTTP request header

/v1/Insights/QM/Categories/{CategoryId}

• CategoryId (path, required) — The ID of the category to be deleted
• Token (header) — The Token HTTP request header

/v1/Insights/QM/Categories/{CategoryId}

To update the category for Questions

• CategoryId (path, required) — The ID of the category to be update
• Token (header) — The Token HTTP request header

/v1/Insights/QM/Questionnaires

To get all questionnaires with questions

• Token (header) — The Token HTTP request header
• IncludeInactive (query) — Flag indicating whether to include inactive questionnaires or not
• PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
• Page (query, page) — The page index. This value is simply for client state.
• PageToken (query) — The page token. This is provided by the API.

/v1/Insights/QM/Questionnaires

To create a Questionnaire

• Token (header) — The Token HTTP request header

/v1/Insights/QM/Questionnaires/{Id}

To delete the questionnaire

• Id (path, required) — The unique ID of the questionnaire
• Token (header) — The Token HTTP request header

/v1/Insights/QM/Questionnaires/{Id}

To get the Questionnaire Detail

• Id (path, required) — The unique ID of the questionnaire
• Token (header) — The Token HTTP request header

/v1/Insights/QM/Questionnaires/{Id}

To update the questionnaire

• Id (path, required) — The unique ID of the questionnaire
• Token (header) — The Token HTTP request header

/v1/Insights/QM/Questions

To get all the question for the given categories

• Token (header) — The Token HTTP request header
• CategoryId (query) — The list of category IDs
• PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
• Page (query, page) — The page index. This value is simply for client state.
• PageToken (query) — The page token. This is provided by the API.

/v1/Insights/QM/Questions

To create a question for a Category

• Token (header) — The Token HTTP request header

/v1/Insights/QM/Questions/{QuestionId}

• QuestionId (path, required) — The unique ID of the question
• Token (header) — The Token HTTP request header

/v1/Insights/QM/Questions/{QuestionId}

To update the question

• QuestionId (path, required) — The unique ID of the question
• Token (header) — The Token HTTP request header

/v1/Insights/QM/Settings/AnswerSets

To get the Answer Set Settings for an Account

• Token (header) — The Token HTTP request header

/v1/Insights/QM/Settings/CommentTags

To get the Comment Settings for an Account

• Token (header) — The Token HTTP request header

/v1/Insights/Segments

To get segments for given reservation Ids

• Token (header) — The Token HTTP request header
• ReservationId (query) — The list of reservation Ids
• PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
• Page (query, page) — The page index. This value is simply for client state.
• PageToken (query) — The page token. This is provided by the API.

/v1/Insights/Segments/{SegmentId}

To get the Segments of an Account

• SegmentId (path, required) — To unique id of the segment
• Token (header) — The Token HTTP request header

/v1/Insights/Session

To obtain session details for fetching reports and dashboards

• Authorization (header) — The Authorization HTTP request header

/v1/Insights/UserRoles

This is used by Flex UI and Quality Management to fetch the Flex Insights roles for the user

• Authorization (header) — The Authorization HTTP request header

/v1/Interactions

Create a new Interaction.

/v1/Interactions/{InteractionSid}/Channels

List all Channels for an Interaction.

• InteractionSid (path, required) — The unique string created by Twilio to identify an Interaction resource, prefixed with KD.
• PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
• Page (query, page) — The page index. This value is simply for client state.
• PageToken (query) — The page token. This is provided by the API.

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

List all Invites for a Channel.

• InteractionSid (path, required) — The Interaction SID for this Channel.
• ChannelSid (path, required) — The Channel SID for this Participant.
• PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
• Page (query, page) — The page index. This value is simply for client state.
• PageToken (query) — The page token. This is provided by the API.

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

Invite an Agent or a TaskQueue to a Channel.

• InteractionSid (path, required) — The Interaction SID for this Channel.
• ChannelSid (path, required) — The Channel SID for this Invite.

/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants

List all Participants for a Channel.

• InteractionSid (path, required) — The Interaction Sid for this channel.
• ChannelSid (path, required) — The Channel Sid for this Participant.
• PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
• Page (query, page) — The page index. This value is simply for client state.
• PageToken (query) — The page token. This is provided by the API.

/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants

Add a Participant to a Channel.

• InteractionSid (path, required) — The Interaction Sid for the new Channel Participant.
• ChannelSid (path, required) — The Channel Sid for the new Channel Participant.

/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants/{Sid}

Update an existing Channel Participant.

• InteractionSid (path, required) — The Interaction Sid for this channel.
• ChannelSid (path, required) — The Channel Sid for this Participant.
• Sid (path, required) — The unique string created by Twilio to identify an Interaction Channel resource.

/v1/Interactions/{InteractionSid}/Channels/{Sid}

Fetch a Channel for an Interaction.

• InteractionSid (path, required) — The unique string created by Twilio to identify an Interaction resource, prefixed with KD.
• Sid (path, required) — The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO.

/v1/Interactions/{InteractionSid}/Channels/{Sid}

Update an existing Interaction Channel.

• InteractionSid (path, required) — The unique string created by Twilio to identify an Interaction resource, prefixed with KD.
• Sid (path, required) — The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO.

/v1/Interactions/{Sid}

• Sid (path, required) — The SID of the Interaction resource to fetch.

/v1/WebChannels

• PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
• Page (query, page) — The page index. This value is simply for client state.
• PageToken (query) — The page token. This is provided by the API.

/v1/WebChannels

/v1/WebChannels/{Sid}

• Sid (path, required) — The SID of the WebChannel resource to delete.

/v1/WebChannels/{Sid}

• Sid (path, required) — The SID of the WebChannel resource to fetch.

/v1/WebChannels/{Sid}

• Sid (path, required) — The SID of the WebChannel resource to update.