Documentation ¶
Index ¶
- type ApiService
- func (c *ApiService) CreateChannel(params *CreateChannelParams) (*FlexV1Channel, error)
- func (c *ApiService) CreateFlexFlow(params *CreateFlexFlowParams) (*FlexV1FlexFlow, error)
- func (c *ApiService) CreateInteraction(params *CreateInteractionParams) (*FlexV1Interaction, error)
- func (c *ApiService) CreateInteractionChannelInvite(InteractionSid string, ChannelSid string, ...) (*FlexV1InteractionChannelInvite, error)
- func (c *ApiService) CreateInteractionChannelParticipant(InteractionSid string, ChannelSid string, ...) (*FlexV1InteractionChannelParticipant, error)
- func (c *ApiService) CreateWebChannel(params *CreateWebChannelParams) (*FlexV1WebChannel, error)
- func (c *ApiService) DeleteChannel(Sid string) error
- func (c *ApiService) DeleteFlexFlow(Sid string) error
- func (c *ApiService) DeleteWebChannel(Sid string) error
- func (c *ApiService) FetchChannel(Sid string) (*FlexV1Channel, error)
- func (c *ApiService) FetchConfiguration(params *FetchConfigurationParams) (*FlexV1Configuration, error)
- func (c *ApiService) FetchFlexFlow(Sid string) (*FlexV1FlexFlow, error)
- func (c *ApiService) FetchInteraction(Sid string) (*FlexV1Interaction, error)
- func (c *ApiService) FetchInteractionChannel(InteractionSid string, Sid string) (*FlexV1InteractionChannel, error)
- func (c *ApiService) FetchWebChannel(Sid string) (*FlexV1WebChannel, error)
- func (c *ApiService) ListChannel(params *ListChannelParams) ([]FlexV1Channel, error)
- func (c *ApiService) ListFlexFlow(params *ListFlexFlowParams) ([]FlexV1FlexFlow, error)
- func (c *ApiService) ListInteractionChannel(InteractionSid string, params *ListInteractionChannelParams) ([]FlexV1InteractionChannel, error)
- func (c *ApiService) ListInteractionChannelInvite(InteractionSid string, ChannelSid string, ...) ([]FlexV1InteractionChannelInvite, error)
- func (c *ApiService) ListInteractionChannelParticipant(InteractionSid string, ChannelSid string, ...) ([]FlexV1InteractionChannelParticipant, error)
- func (c *ApiService) ListWebChannel(params *ListWebChannelParams) ([]FlexV1WebChannel, error)
- func (c *ApiService) PageChannel(params *ListChannelParams, pageToken, pageNumber string) (*ListChannelResponse, error)
- func (c *ApiService) PageFlexFlow(params *ListFlexFlowParams, pageToken, pageNumber string) (*ListFlexFlowResponse, error)
- func (c *ApiService) PageInteractionChannel(InteractionSid string, params *ListInteractionChannelParams, ...) (*ListInteractionChannelResponse, error)
- func (c *ApiService) PageInteractionChannelInvite(InteractionSid string, ChannelSid string, ...) (*ListInteractionChannelInviteResponse, error)
- func (c *ApiService) PageInteractionChannelParticipant(InteractionSid string, ChannelSid string, ...) (*ListInteractionChannelParticipantResponse, error)
- func (c *ApiService) PageWebChannel(params *ListWebChannelParams, pageToken, pageNumber string) (*ListWebChannelResponse, error)
- func (c *ApiService) StreamChannel(params *ListChannelParams) (chan FlexV1Channel, chan error)
- func (c *ApiService) StreamFlexFlow(params *ListFlexFlowParams) (chan FlexV1FlexFlow, chan error)
- func (c *ApiService) StreamInteractionChannel(InteractionSid string, params *ListInteractionChannelParams) (chan FlexV1InteractionChannel, chan error)
- func (c *ApiService) StreamInteractionChannelInvite(InteractionSid string, ChannelSid string, ...) (chan FlexV1InteractionChannelInvite, chan error)
- func (c *ApiService) StreamInteractionChannelParticipant(InteractionSid string, ChannelSid string, ...) (chan FlexV1InteractionChannelParticipant, chan error)
- func (c *ApiService) StreamWebChannel(params *ListWebChannelParams) (chan FlexV1WebChannel, chan error)
- func (c *ApiService) UpdateFlexFlow(Sid string, params *UpdateFlexFlowParams) (*FlexV1FlexFlow, error)
- func (c *ApiService) UpdateInteractionChannel(InteractionSid string, Sid string, params *UpdateInteractionChannelParams) (*FlexV1InteractionChannel, error)
- func (c *ApiService) UpdateInteractionChannelParticipant(InteractionSid string, ChannelSid string, Sid string, ...) (*FlexV1InteractionChannelParticipant, error)
- func (c *ApiService) UpdateWebChannel(Sid string, params *UpdateWebChannelParams) (*FlexV1WebChannel, error)
- type CreateChannelParams
- func (params *CreateChannelParams) SetChatFriendlyName(ChatFriendlyName string) *CreateChannelParams
- func (params *CreateChannelParams) SetChatUniqueName(ChatUniqueName string) *CreateChannelParams
- func (params *CreateChannelParams) SetChatUserFriendlyName(ChatUserFriendlyName string) *CreateChannelParams
- func (params *CreateChannelParams) SetFlexFlowSid(FlexFlowSid string) *CreateChannelParams
- func (params *CreateChannelParams) SetIdentity(Identity string) *CreateChannelParams
- func (params *CreateChannelParams) SetLongLived(LongLived bool) *CreateChannelParams
- func (params *CreateChannelParams) SetPreEngagementData(PreEngagementData string) *CreateChannelParams
- func (params *CreateChannelParams) SetTarget(Target string) *CreateChannelParams
- func (params *CreateChannelParams) SetTaskAttributes(TaskAttributes string) *CreateChannelParams
- func (params *CreateChannelParams) SetTaskSid(TaskSid string) *CreateChannelParams
- type CreateFlexFlowParams
- func (params *CreateFlexFlowParams) SetChannelType(ChannelType string) *CreateFlexFlowParams
- func (params *CreateFlexFlowParams) SetChatServiceSid(ChatServiceSid string) *CreateFlexFlowParams
- func (params *CreateFlexFlowParams) SetContactIdentity(ContactIdentity string) *CreateFlexFlowParams
- func (params *CreateFlexFlowParams) SetEnabled(Enabled bool) *CreateFlexFlowParams
- func (params *CreateFlexFlowParams) SetFriendlyName(FriendlyName string) *CreateFlexFlowParams
- func (params *CreateFlexFlowParams) SetIntegrationChannel(IntegrationChannel string) *CreateFlexFlowParams
- func (params *CreateFlexFlowParams) SetIntegrationCreationOnMessage(IntegrationCreationOnMessage bool) *CreateFlexFlowParams
- func (params *CreateFlexFlowParams) SetIntegrationFlowSid(IntegrationFlowSid string) *CreateFlexFlowParams
- func (params *CreateFlexFlowParams) SetIntegrationPriority(IntegrationPriority int) *CreateFlexFlowParams
- func (params *CreateFlexFlowParams) SetIntegrationRetryCount(IntegrationRetryCount int) *CreateFlexFlowParams
- func (params *CreateFlexFlowParams) SetIntegrationTimeout(IntegrationTimeout int) *CreateFlexFlowParams
- func (params *CreateFlexFlowParams) SetIntegrationType(IntegrationType string) *CreateFlexFlowParams
- func (params *CreateFlexFlowParams) SetIntegrationUrl(IntegrationUrl string) *CreateFlexFlowParams
- func (params *CreateFlexFlowParams) SetIntegrationWorkflowSid(IntegrationWorkflowSid string) *CreateFlexFlowParams
- func (params *CreateFlexFlowParams) SetIntegrationWorkspaceSid(IntegrationWorkspaceSid string) *CreateFlexFlowParams
- func (params *CreateFlexFlowParams) SetJanitorEnabled(JanitorEnabled bool) *CreateFlexFlowParams
- func (params *CreateFlexFlowParams) SetLongLived(LongLived bool) *CreateFlexFlowParams
- type CreateInteractionChannelInviteParams
- type CreateInteractionChannelParticipantParams
- type CreateInteractionParams
- type CreateWebChannelParams
- func (params *CreateWebChannelParams) SetChatFriendlyName(ChatFriendlyName string) *CreateWebChannelParams
- func (params *CreateWebChannelParams) SetChatUniqueName(ChatUniqueName string) *CreateWebChannelParams
- func (params *CreateWebChannelParams) SetCustomerFriendlyName(CustomerFriendlyName string) *CreateWebChannelParams
- func (params *CreateWebChannelParams) SetFlexFlowSid(FlexFlowSid string) *CreateWebChannelParams
- func (params *CreateWebChannelParams) SetIdentity(Identity string) *CreateWebChannelParams
- func (params *CreateWebChannelParams) SetPreEngagementData(PreEngagementData string) *CreateWebChannelParams
- type FetchConfigurationParams
- type FlexV1Channel
- type FlexV1Configuration
- type FlexV1FlexFlow
- type FlexV1Interaction
- type FlexV1InteractionChannel
- type FlexV1InteractionChannelInvite
- type FlexV1InteractionChannelParticipant
- type FlexV1WebChannel
- type ListChannelParams
- type ListChannelResponse
- type ListChannelResponseMeta
- type ListFlexFlowParams
- type ListFlexFlowResponse
- type ListInteractionChannelInviteParams
- type ListInteractionChannelInviteResponse
- type ListInteractionChannelParams
- type ListInteractionChannelParticipantParams
- type ListInteractionChannelParticipantResponse
- type ListInteractionChannelResponse
- type ListWebChannelParams
- type ListWebChannelResponse
- type UpdateFlexFlowParams
- func (params *UpdateFlexFlowParams) SetChannelType(ChannelType string) *UpdateFlexFlowParams
- func (params *UpdateFlexFlowParams) SetChatServiceSid(ChatServiceSid string) *UpdateFlexFlowParams
- func (params *UpdateFlexFlowParams) SetContactIdentity(ContactIdentity string) *UpdateFlexFlowParams
- func (params *UpdateFlexFlowParams) SetEnabled(Enabled bool) *UpdateFlexFlowParams
- func (params *UpdateFlexFlowParams) SetFriendlyName(FriendlyName string) *UpdateFlexFlowParams
- func (params *UpdateFlexFlowParams) SetIntegrationChannel(IntegrationChannel string) *UpdateFlexFlowParams
- func (params *UpdateFlexFlowParams) SetIntegrationCreationOnMessage(IntegrationCreationOnMessage bool) *UpdateFlexFlowParams
- func (params *UpdateFlexFlowParams) SetIntegrationFlowSid(IntegrationFlowSid string) *UpdateFlexFlowParams
- func (params *UpdateFlexFlowParams) SetIntegrationPriority(IntegrationPriority int) *UpdateFlexFlowParams
- func (params *UpdateFlexFlowParams) SetIntegrationRetryCount(IntegrationRetryCount int) *UpdateFlexFlowParams
- func (params *UpdateFlexFlowParams) SetIntegrationTimeout(IntegrationTimeout int) *UpdateFlexFlowParams
- func (params *UpdateFlexFlowParams) SetIntegrationType(IntegrationType string) *UpdateFlexFlowParams
- func (params *UpdateFlexFlowParams) SetIntegrationUrl(IntegrationUrl string) *UpdateFlexFlowParams
- func (params *UpdateFlexFlowParams) SetIntegrationWorkflowSid(IntegrationWorkflowSid string) *UpdateFlexFlowParams
- func (params *UpdateFlexFlowParams) SetIntegrationWorkspaceSid(IntegrationWorkspaceSid string) *UpdateFlexFlowParams
- func (params *UpdateFlexFlowParams) SetJanitorEnabled(JanitorEnabled bool) *UpdateFlexFlowParams
- func (params *UpdateFlexFlowParams) SetLongLived(LongLived bool) *UpdateFlexFlowParams
- type UpdateInteractionChannelParams
- type UpdateInteractionChannelParticipantParams
- type UpdateWebChannelParams
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApiService ¶ added in v0.11.0
type ApiService struct {
// contains filtered or unexported fields
}
func NewApiService ¶ added in v0.11.0
func NewApiService(requestHandler *twilio.RequestHandler) *ApiService
func NewApiServiceWithClient ¶ added in v0.11.0
func NewApiServiceWithClient(client twilio.BaseClient) *ApiService
func (*ApiService) CreateChannel ¶ added in v0.11.0
func (c *ApiService) CreateChannel(params *CreateChannelParams) (*FlexV1Channel, error)
func (*ApiService) CreateFlexFlow ¶ added in v0.11.0
func (c *ApiService) CreateFlexFlow(params *CreateFlexFlowParams) (*FlexV1FlexFlow, error)
func (*ApiService) CreateInteraction ¶ added in v0.23.0
func (c *ApiService) CreateInteraction(params *CreateInteractionParams) (*FlexV1Interaction, error)
Create a new Interaction.
func (*ApiService) CreateInteractionChannelInvite ¶ added in v0.23.0
func (c *ApiService) CreateInteractionChannelInvite(InteractionSid string, ChannelSid string, params *CreateInteractionChannelInviteParams) (*FlexV1InteractionChannelInvite, error)
Invite an Agent or a TaskQueue to a Channel.
func (*ApiService) CreateInteractionChannelParticipant ¶ added in v0.23.0
func (c *ApiService) CreateInteractionChannelParticipant(InteractionSid string, ChannelSid string, params *CreateInteractionChannelParticipantParams) (*FlexV1InteractionChannelParticipant, error)
Add a Participant to a Channel.
func (*ApiService) CreateWebChannel ¶ added in v0.11.0
func (c *ApiService) CreateWebChannel(params *CreateWebChannelParams) (*FlexV1WebChannel, error)
func (*ApiService) DeleteChannel ¶ added in v0.11.0
func (c *ApiService) DeleteChannel(Sid string) error
func (*ApiService) DeleteFlexFlow ¶ added in v0.11.0
func (c *ApiService) DeleteFlexFlow(Sid string) error
func (*ApiService) DeleteWebChannel ¶ added in v0.11.0
func (c *ApiService) DeleteWebChannel(Sid string) error
func (*ApiService) FetchChannel ¶ added in v0.11.0
func (c *ApiService) FetchChannel(Sid string) (*FlexV1Channel, error)
func (*ApiService) FetchConfiguration ¶ added in v0.11.0
func (c *ApiService) FetchConfiguration(params *FetchConfigurationParams) (*FlexV1Configuration, error)
func (*ApiService) FetchFlexFlow ¶ added in v0.11.0
func (c *ApiService) FetchFlexFlow(Sid string) (*FlexV1FlexFlow, error)
func (*ApiService) FetchInteraction ¶ added in v0.23.0
func (c *ApiService) FetchInteraction(Sid string) (*FlexV1Interaction, error)
func (*ApiService) FetchInteractionChannel ¶ added in v0.23.0
func (c *ApiService) FetchInteractionChannel(InteractionSid string, Sid string) (*FlexV1InteractionChannel, error)
Fetch a Channel for an Interaction.
func (*ApiService) FetchWebChannel ¶ added in v0.11.0
func (c *ApiService) FetchWebChannel(Sid string) (*FlexV1WebChannel, error)
func (*ApiService) ListChannel ¶ added in v0.11.0
func (c *ApiService) ListChannel(params *ListChannelParams) ([]FlexV1Channel, error)
Lists Channel records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.
func (*ApiService) ListFlexFlow ¶ added in v0.11.0
func (c *ApiService) ListFlexFlow(params *ListFlexFlowParams) ([]FlexV1FlexFlow, error)
Lists FlexFlow records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.
func (*ApiService) ListInteractionChannel ¶ added in v0.23.0
func (c *ApiService) ListInteractionChannel(InteractionSid string, params *ListInteractionChannelParams) ([]FlexV1InteractionChannel, error)
Lists InteractionChannel records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.
func (*ApiService) ListInteractionChannelInvite ¶ added in v0.23.0
func (c *ApiService) ListInteractionChannelInvite(InteractionSid string, ChannelSid string, params *ListInteractionChannelInviteParams) ([]FlexV1InteractionChannelInvite, error)
Lists InteractionChannelInvite records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.
func (*ApiService) ListInteractionChannelParticipant ¶ added in v0.23.0
func (c *ApiService) ListInteractionChannelParticipant(InteractionSid string, ChannelSid string, params *ListInteractionChannelParticipantParams) ([]FlexV1InteractionChannelParticipant, error)
Lists InteractionChannelParticipant records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.
func (*ApiService) ListWebChannel ¶ added in v0.11.0
func (c *ApiService) ListWebChannel(params *ListWebChannelParams) ([]FlexV1WebChannel, error)
Lists WebChannel records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.
func (*ApiService) PageChannel ¶ added in v0.13.0
func (c *ApiService) PageChannel(params *ListChannelParams, pageToken, pageNumber string) (*ListChannelResponse, error)
Retrieve a single page of Channel records from the API. Request is executed immediately.
func (*ApiService) PageFlexFlow ¶ added in v0.13.0
func (c *ApiService) PageFlexFlow(params *ListFlexFlowParams, pageToken, pageNumber string) (*ListFlexFlowResponse, error)
Retrieve a single page of FlexFlow records from the API. Request is executed immediately.
func (*ApiService) PageInteractionChannel ¶ added in v0.23.0
func (c *ApiService) PageInteractionChannel(InteractionSid string, params *ListInteractionChannelParams, pageToken, pageNumber string) (*ListInteractionChannelResponse, error)
Retrieve a single page of InteractionChannel records from the API. Request is executed immediately.
func (*ApiService) PageInteractionChannelInvite ¶ added in v0.23.0
func (c *ApiService) PageInteractionChannelInvite(InteractionSid string, ChannelSid string, params *ListInteractionChannelInviteParams, pageToken, pageNumber string) (*ListInteractionChannelInviteResponse, error)
Retrieve a single page of InteractionChannelInvite records from the API. Request is executed immediately.
func (*ApiService) PageInteractionChannelParticipant ¶ added in v0.23.0
func (c *ApiService) PageInteractionChannelParticipant(InteractionSid string, ChannelSid string, params *ListInteractionChannelParticipantParams, pageToken, pageNumber string) (*ListInteractionChannelParticipantResponse, error)
Retrieve a single page of InteractionChannelParticipant records from the API. Request is executed immediately.
func (*ApiService) PageWebChannel ¶ added in v0.13.0
func (c *ApiService) PageWebChannel(params *ListWebChannelParams, pageToken, pageNumber string) (*ListWebChannelResponse, error)
Retrieve a single page of WebChannel records from the API. Request is executed immediately.
func (*ApiService) StreamChannel ¶ added in v0.13.0
func (c *ApiService) StreamChannel(params *ListChannelParams) (chan FlexV1Channel, chan error)
Streams Channel records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.
func (*ApiService) StreamFlexFlow ¶ added in v0.13.0
func (c *ApiService) StreamFlexFlow(params *ListFlexFlowParams) (chan FlexV1FlexFlow, chan error)
Streams FlexFlow records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.
func (*ApiService) StreamInteractionChannel ¶ added in v0.23.0
func (c *ApiService) StreamInteractionChannel(InteractionSid string, params *ListInteractionChannelParams) (chan FlexV1InteractionChannel, chan error)
Streams InteractionChannel records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.
func (*ApiService) StreamInteractionChannelInvite ¶ added in v0.23.0
func (c *ApiService) StreamInteractionChannelInvite(InteractionSid string, ChannelSid string, params *ListInteractionChannelInviteParams) (chan FlexV1InteractionChannelInvite, chan error)
Streams InteractionChannelInvite records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.
func (*ApiService) StreamInteractionChannelParticipant ¶ added in v0.23.0
func (c *ApiService) StreamInteractionChannelParticipant(InteractionSid string, ChannelSid string, params *ListInteractionChannelParticipantParams) (chan FlexV1InteractionChannelParticipant, chan error)
Streams InteractionChannelParticipant records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.
func (*ApiService) StreamWebChannel ¶ added in v0.13.0
func (c *ApiService) StreamWebChannel(params *ListWebChannelParams) (chan FlexV1WebChannel, chan error)
Streams WebChannel records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.
func (*ApiService) UpdateFlexFlow ¶ added in v0.11.0
func (c *ApiService) UpdateFlexFlow(Sid string, params *UpdateFlexFlowParams) (*FlexV1FlexFlow, error)
func (*ApiService) UpdateInteractionChannel ¶ added in v0.23.0
func (c *ApiService) UpdateInteractionChannel(InteractionSid string, Sid string, params *UpdateInteractionChannelParams) (*FlexV1InteractionChannel, error)
Update an existing Interaction Channel.
func (*ApiService) UpdateInteractionChannelParticipant ¶ added in v0.23.0
func (c *ApiService) UpdateInteractionChannelParticipant(InteractionSid string, ChannelSid string, Sid string, params *UpdateInteractionChannelParticipantParams) (*FlexV1InteractionChannelParticipant, error)
Update an existing Channel Participant.
func (*ApiService) UpdateWebChannel ¶ added in v0.11.0
func (c *ApiService) UpdateWebChannel(Sid string, params *UpdateWebChannelParams) (*FlexV1WebChannel, error)
type CreateChannelParams ¶
type CreateChannelParams struct { // The SID of the Flex Flow. FlexFlowSid *string `json:"FlexFlowSid,omitempty"` // The `identity` value that uniquely identifies the new resource's chat User. Identity *string `json:"Identity,omitempty"` // The chat participant's friendly name. ChatUserFriendlyName *string `json:"ChatUserFriendlyName,omitempty"` // The chat channel's friendly name. ChatFriendlyName *string `json:"ChatFriendlyName,omitempty"` // The Target Contact Identity, for example the phone number of an SMS. Target *string `json:"Target,omitempty"` // The chat channel's unique name. ChatUniqueName *string `json:"ChatUniqueName,omitempty"` // The pre-engagement data. PreEngagementData *string `json:"PreEngagementData,omitempty"` // The SID of the TaskRouter Task. Only valid when integration type is `task`. `null` for integration types `studio` & `external` TaskSid *string `json:"TaskSid,omitempty"` // The Task attributes to be added for the TaskRouter Task. TaskAttributes *string `json:"TaskAttributes,omitempty"` // Whether to create the channel as long-lived. LongLived *bool `json:"LongLived,omitempty"` }
Optional parameters for the method 'CreateChannel'
func (*CreateChannelParams) SetChatFriendlyName ¶
func (params *CreateChannelParams) SetChatFriendlyName(ChatFriendlyName string) *CreateChannelParams
func (*CreateChannelParams) SetChatUniqueName ¶
func (params *CreateChannelParams) SetChatUniqueName(ChatUniqueName string) *CreateChannelParams
func (*CreateChannelParams) SetChatUserFriendlyName ¶
func (params *CreateChannelParams) SetChatUserFriendlyName(ChatUserFriendlyName string) *CreateChannelParams
func (*CreateChannelParams) SetFlexFlowSid ¶
func (params *CreateChannelParams) SetFlexFlowSid(FlexFlowSid string) *CreateChannelParams
func (*CreateChannelParams) SetIdentity ¶
func (params *CreateChannelParams) SetIdentity(Identity string) *CreateChannelParams
func (*CreateChannelParams) SetLongLived ¶
func (params *CreateChannelParams) SetLongLived(LongLived bool) *CreateChannelParams
func (*CreateChannelParams) SetPreEngagementData ¶
func (params *CreateChannelParams) SetPreEngagementData(PreEngagementData string) *CreateChannelParams
func (*CreateChannelParams) SetTarget ¶
func (params *CreateChannelParams) SetTarget(Target string) *CreateChannelParams
func (*CreateChannelParams) SetTaskAttributes ¶
func (params *CreateChannelParams) SetTaskAttributes(TaskAttributes string) *CreateChannelParams
func (*CreateChannelParams) SetTaskSid ¶
func (params *CreateChannelParams) SetTaskSid(TaskSid string) *CreateChannelParams
type CreateFlexFlowParams ¶
type CreateFlexFlowParams struct { // A descriptive string that you create to describe the Flex Flow resource. FriendlyName *string `json:"FriendlyName,omitempty"` // The SID of the chat service. ChatServiceSid *string `json:"ChatServiceSid,omitempty"` // ChannelType *string `json:"ChannelType,omitempty"` // The channel contact's Identity. ContactIdentity *string `json:"ContactIdentity,omitempty"` // Whether the new Flex Flow is enabled. Enabled *bool `json:"Enabled,omitempty"` // IntegrationType *string `json:"IntegrationType,omitempty"` // The SID of the Studio Flow. Required when `integrationType` is `studio`. IntegrationFlowSid *string `json:"Integration.FlowSid,omitempty"` // The URL of the external webhook. Required when `integrationType` is `external`. IntegrationUrl *string `json:"Integration.Url,omitempty"` // The Workspace SID for a new Task. Required when `integrationType` is `task`. IntegrationWorkspaceSid *string `json:"Integration.WorkspaceSid,omitempty"` // The Workflow SID for a new Task. Required when `integrationType` is `task`. IntegrationWorkflowSid *string `json:"Integration.WorkflowSid,omitempty"` // The Task Channel SID (TCXXXX) or unique name (e.g., `sms`) to use for the Task that will be created. Applicable and required when `integrationType` is `task`. The default value is `default`. IntegrationChannel *string `json:"Integration.Channel,omitempty"` // The Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`, not applicable otherwise. IntegrationTimeout *int `json:"Integration.Timeout,omitempty"` // The Task priority of a new Task. The default priority is 0. Optional when `integrationType` is `task`, not applicable otherwise. IntegrationPriority *int `json:"Integration.Priority,omitempty"` // In the context of outbound messaging, defines whether to create a Task immediately (and therefore reserve the conversation to current agent), or delay Task creation until the customer sends the first response. Set to false to create immediately, true to delay Task creation. This setting is only applicable for outbound messaging. IntegrationCreationOnMessage *bool `json:"Integration.CreationOnMessage,omitempty"` // When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to `false`. LongLived *bool `json:"LongLived,omitempty"` // When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to `false`. JanitorEnabled *bool `json:"JanitorEnabled,omitempty"` // The number of times to retry the Studio Flow or webhook in case of failure. Takes integer values from 0 to 3 with the default being 3. Optional when `integrationType` is `studio` or `external`, not applicable otherwise. IntegrationRetryCount *int `json:"Integration.RetryCount,omitempty"` }
Optional parameters for the method 'CreateFlexFlow'
func (*CreateFlexFlowParams) SetChannelType ¶
func (params *CreateFlexFlowParams) SetChannelType(ChannelType string) *CreateFlexFlowParams
func (*CreateFlexFlowParams) SetChatServiceSid ¶
func (params *CreateFlexFlowParams) SetChatServiceSid(ChatServiceSid string) *CreateFlexFlowParams
func (*CreateFlexFlowParams) SetContactIdentity ¶
func (params *CreateFlexFlowParams) SetContactIdentity(ContactIdentity string) *CreateFlexFlowParams
func (*CreateFlexFlowParams) SetEnabled ¶
func (params *CreateFlexFlowParams) SetEnabled(Enabled bool) *CreateFlexFlowParams
func (*CreateFlexFlowParams) SetFriendlyName ¶
func (params *CreateFlexFlowParams) SetFriendlyName(FriendlyName string) *CreateFlexFlowParams
func (*CreateFlexFlowParams) SetIntegrationChannel ¶
func (params *CreateFlexFlowParams) SetIntegrationChannel(IntegrationChannel string) *CreateFlexFlowParams
func (*CreateFlexFlowParams) SetIntegrationCreationOnMessage ¶
func (params *CreateFlexFlowParams) SetIntegrationCreationOnMessage(IntegrationCreationOnMessage bool) *CreateFlexFlowParams
func (*CreateFlexFlowParams) SetIntegrationFlowSid ¶
func (params *CreateFlexFlowParams) SetIntegrationFlowSid(IntegrationFlowSid string) *CreateFlexFlowParams
func (*CreateFlexFlowParams) SetIntegrationPriority ¶
func (params *CreateFlexFlowParams) SetIntegrationPriority(IntegrationPriority int) *CreateFlexFlowParams
func (*CreateFlexFlowParams) SetIntegrationRetryCount ¶
func (params *CreateFlexFlowParams) SetIntegrationRetryCount(IntegrationRetryCount int) *CreateFlexFlowParams
func (*CreateFlexFlowParams) SetIntegrationTimeout ¶
func (params *CreateFlexFlowParams) SetIntegrationTimeout(IntegrationTimeout int) *CreateFlexFlowParams
func (*CreateFlexFlowParams) SetIntegrationType ¶
func (params *CreateFlexFlowParams) SetIntegrationType(IntegrationType string) *CreateFlexFlowParams
func (*CreateFlexFlowParams) SetIntegrationUrl ¶
func (params *CreateFlexFlowParams) SetIntegrationUrl(IntegrationUrl string) *CreateFlexFlowParams
func (*CreateFlexFlowParams) SetIntegrationWorkflowSid ¶
func (params *CreateFlexFlowParams) SetIntegrationWorkflowSid(IntegrationWorkflowSid string) *CreateFlexFlowParams
func (*CreateFlexFlowParams) SetIntegrationWorkspaceSid ¶
func (params *CreateFlexFlowParams) SetIntegrationWorkspaceSid(IntegrationWorkspaceSid string) *CreateFlexFlowParams
func (*CreateFlexFlowParams) SetJanitorEnabled ¶
func (params *CreateFlexFlowParams) SetJanitorEnabled(JanitorEnabled bool) *CreateFlexFlowParams
func (*CreateFlexFlowParams) SetLongLived ¶
func (params *CreateFlexFlowParams) SetLongLived(LongLived bool) *CreateFlexFlowParams
type CreateInteractionChannelInviteParams ¶ added in v0.23.0
type CreateInteractionChannelInviteParams struct {
// The Interaction's routing logic.
Routing *interface{} `json:"Routing,omitempty"`
}
Optional parameters for the method 'CreateInteractionChannelInvite'
func (*CreateInteractionChannelInviteParams) SetRouting ¶ added in v0.23.0
func (params *CreateInteractionChannelInviteParams) SetRouting(Routing interface{}) *CreateInteractionChannelInviteParams
type CreateInteractionChannelParticipantParams ¶ added in v0.23.0
type CreateInteractionChannelParticipantParams struct { // Type *string `json:"Type,omitempty"` // JSON representing the Media Properties for the new Participant. MediaProperties *interface{} `json:"MediaProperties,omitempty"` }
Optional parameters for the method 'CreateInteractionChannelParticipant'
func (*CreateInteractionChannelParticipantParams) SetMediaProperties ¶ added in v0.23.0
func (params *CreateInteractionChannelParticipantParams) SetMediaProperties(MediaProperties interface{}) *CreateInteractionChannelParticipantParams
func (*CreateInteractionChannelParticipantParams) SetType ¶ added in v0.23.0
func (params *CreateInteractionChannelParticipantParams) SetType(Type string) *CreateInteractionChannelParticipantParams
type CreateInteractionParams ¶ added in v0.23.0
type CreateInteractionParams struct { // The Interaction's channel. Channel *interface{} `json:"Channel,omitempty"` // The Interaction's routing logic. Routing *interface{} `json:"Routing,omitempty"` }
Optional parameters for the method 'CreateInteraction'
func (*CreateInteractionParams) SetChannel ¶ added in v0.23.0
func (params *CreateInteractionParams) SetChannel(Channel interface{}) *CreateInteractionParams
func (*CreateInteractionParams) SetRouting ¶ added in v0.23.0
func (params *CreateInteractionParams) SetRouting(Routing interface{}) *CreateInteractionParams
type CreateWebChannelParams ¶
type CreateWebChannelParams struct { // The SID of the Flex Flow. FlexFlowSid *string `json:"FlexFlowSid,omitempty"` // The chat identity. Identity *string `json:"Identity,omitempty"` // The chat participant's friendly name. CustomerFriendlyName *string `json:"CustomerFriendlyName,omitempty"` // The chat channel's friendly name. ChatFriendlyName *string `json:"ChatFriendlyName,omitempty"` // The chat channel's unique name. ChatUniqueName *string `json:"ChatUniqueName,omitempty"` // The pre-engagement data. PreEngagementData *string `json:"PreEngagementData,omitempty"` }
Optional parameters for the method 'CreateWebChannel'
func (*CreateWebChannelParams) SetChatFriendlyName ¶
func (params *CreateWebChannelParams) SetChatFriendlyName(ChatFriendlyName string) *CreateWebChannelParams
func (*CreateWebChannelParams) SetChatUniqueName ¶
func (params *CreateWebChannelParams) SetChatUniqueName(ChatUniqueName string) *CreateWebChannelParams
func (*CreateWebChannelParams) SetCustomerFriendlyName ¶
func (params *CreateWebChannelParams) SetCustomerFriendlyName(CustomerFriendlyName string) *CreateWebChannelParams
func (*CreateWebChannelParams) SetFlexFlowSid ¶
func (params *CreateWebChannelParams) SetFlexFlowSid(FlexFlowSid string) *CreateWebChannelParams
func (*CreateWebChannelParams) SetIdentity ¶
func (params *CreateWebChannelParams) SetIdentity(Identity string) *CreateWebChannelParams
func (*CreateWebChannelParams) SetPreEngagementData ¶
func (params *CreateWebChannelParams) SetPreEngagementData(PreEngagementData string) *CreateWebChannelParams
type FetchConfigurationParams ¶
type FetchConfigurationParams struct { // The Pinned UI version of the Configuration resource to fetch. UiVersion *string `json:"UiVersion,omitempty"` }
Optional parameters for the method 'FetchConfiguration'
func (*FetchConfigurationParams) SetUiVersion ¶
func (params *FetchConfigurationParams) SetUiVersion(UiVersion string) *FetchConfigurationParams
type FlexV1Channel ¶
type FlexV1Channel struct { // The SID of the Account that created the resource and owns this Workflow AccountSid *string `json:"account_sid,omitempty"` // The SID of the Flex Flow FlexFlowSid *string `json:"flex_flow_sid,omitempty"` // The unique string that identifies the resource Sid *string `json:"sid,omitempty"` // The SID of the chat user UserSid *string `json:"user_sid,omitempty"` // The SID of the TaskRouter Task TaskSid *string `json:"task_sid,omitempty"` // The absolute URL of the Flex chat channel resource Url *string `json:"url,omitempty"` // The ISO 8601 date and time in GMT when the Flex chat channel was created DateCreated *time.Time `json:"date_created,omitempty"` // The ISO 8601 date and time in GMT when the Flex chat channel was last updated DateUpdated *time.Time `json:"date_updated,omitempty"` }
FlexV1Channel struct for FlexV1Channel
type FlexV1Configuration ¶
type FlexV1Configuration struct { // The SID of the Account that created the resource AccountSid *string `json:"account_sid,omitempty"` // The ISO 8601 date and time in GMT when the Configuration resource was created DateCreated *time.Time `json:"date_created,omitempty"` // The ISO 8601 date and time in GMT when the Configuration resource was last updated DateUpdated *time.Time `json:"date_updated,omitempty"` // An object that contains application-specific data Attributes *interface{} `json:"attributes,omitempty"` Status *string `json:"status,omitempty"` // The SID of the TaskRouter Workspace TaskrouterWorkspaceSid *string `json:"taskrouter_workspace_sid,omitempty"` // The SID of the TaskRouter target Workflow TaskrouterTargetWorkflowSid *string `json:"taskrouter_target_workflow_sid,omitempty"` // The SID of the TaskRouter Target TaskQueue TaskrouterTargetTaskqueueSid *string `json:"taskrouter_target_taskqueue_sid,omitempty"` // The list of TaskRouter TaskQueues TaskrouterTaskqueues *[]interface{} `json:"taskrouter_taskqueues,omitempty"` // The Skill description for TaskRouter workers TaskrouterSkills *[]interface{} `json:"taskrouter_skills,omitempty"` // The TaskRouter default channel capacities and availability for workers TaskrouterWorkerChannels *interface{} `json:"taskrouter_worker_channels,omitempty"` // The TaskRouter Worker attributes TaskrouterWorkerAttributes *interface{} `json:"taskrouter_worker_attributes,omitempty"` // The TaskRouter SID of the offline activity TaskrouterOfflineActivitySid *string `json:"taskrouter_offline_activity_sid,omitempty"` // The URL where the Flex instance is hosted RuntimeDomain *string `json:"runtime_domain,omitempty"` // The SID of the Messaging service instance MessagingServiceInstanceSid *string `json:"messaging_service_instance_sid,omitempty"` // The SID of the chat service this user belongs to ChatServiceInstanceSid *string `json:"chat_service_instance_sid,omitempty"` // The SID of the Flex service instance FlexServiceInstanceSid *string `json:"flex_service_instance_sid,omitempty"` // The primary language of the Flex UI UiLanguage *string `json:"ui_language,omitempty"` // The object that describes Flex UI characteristics and settings UiAttributes *interface{} `json:"ui_attributes,omitempty"` // The object that defines the NPM packages and versions to be used in Hosted Flex UiDependencies *interface{} `json:"ui_dependencies,omitempty"` // The Pinned UI version UiVersion *string `json:"ui_version,omitempty"` // The Flex Service version ServiceVersion *string `json:"service_version,omitempty"` // Whether call recording is enabled CallRecordingEnabled *bool `json:"call_recording_enabled,omitempty"` // The call recording webhook URL CallRecordingWebhookUrl *string `json:"call_recording_webhook_url,omitempty"` // Whether CRM is present for Flex CrmEnabled *bool `json:"crm_enabled,omitempty"` // The CRM Type CrmType *string `json:"crm_type,omitempty"` // The CRM Callback URL CrmCallbackUrl *string `json:"crm_callback_url,omitempty"` // The CRM Fallback URL CrmFallbackUrl *string `json:"crm_fallback_url,omitempty"` // An object that contains the CRM attributes CrmAttributes *interface{} `json:"crm_attributes,omitempty"` // The list of public attributes PublicAttributes *interface{} `json:"public_attributes,omitempty"` // Whether the plugin service enabled PluginServiceEnabled *bool `json:"plugin_service_enabled,omitempty"` // The plugin service attributes PluginServiceAttributes *interface{} `json:"plugin_service_attributes,omitempty"` // A list of objects that contain the configurations for the Integrations supported in this configuration Integrations *[]interface{} `json:"integrations,omitempty"` // The list of outbound call flows OutboundCallFlows *interface{} `json:"outbound_call_flows,omitempty"` // The list of serverless service SIDs ServerlessServiceSids *[]string `json:"serverless_service_sids,omitempty"` // Configurable parameters for Queues Statistics QueueStatsConfiguration *interface{} `json:"queue_stats_configuration,omitempty"` // Configurable parameters for Notifications Notifications *interface{} `json:"notifications,omitempty"` // Configurable parameters for Markdown Markdown *interface{} `json:"markdown,omitempty"` // The absolute URL of the Configuration resource Url *string `json:"url,omitempty"` // Object that controls workspace reporting FlexInsightsHr *interface{} `json:"flex_insights_hr,omitempty"` // Setting to enable Flex UI redirection FlexInsightsDrilldown *bool `json:"flex_insights_drilldown,omitempty"` // URL to redirect to in case drilldown is enabled. FlexUrl *string `json:"flex_url,omitempty"` // Flex Conversations channels' attachments configurations ChannelConfigs *[]interface{} `json:"channel_configs,omitempty"` // Configurable parameters for Debugger Integration DebuggerIntegration *interface{} `json:"debugger_integration,omitempty"` // Configurable parameters for Flex UI Status report FlexUiStatusReport *interface{} `json:"flex_ui_status_report,omitempty"` }
FlexV1Configuration struct for FlexV1Configuration
type FlexV1FlexFlow ¶
type FlexV1FlexFlow struct { // The SID of the Account that created the resource AccountSid *string `json:"account_sid,omitempty"` // The ISO 8601 date and time in GMT when the resource was created DateCreated *time.Time `json:"date_created,omitempty"` // The ISO 8601 date and time in GMT when the resource was last updated DateUpdated *time.Time `json:"date_updated,omitempty"` // The unique string that identifies the resource Sid *string `json:"sid,omitempty"` // The string that you assigned to describe the resource FriendlyName *string `json:"friendly_name,omitempty"` // The SID of the chat service ChatServiceSid *string `json:"chat_service_sid,omitempty"` ChannelType *string `json:"channel_type,omitempty"` // The channel contact's Identity ContactIdentity *string `json:"contact_identity,omitempty"` // Whether the Flex Flow is enabled Enabled *bool `json:"enabled,omitempty"` IntegrationType *string `json:"integration_type,omitempty"` // An object that contains specific parameters for the integration Integration *interface{} `json:"integration,omitempty"` // Re-use this chat channel for future interactions with a contact LongLived *bool `json:"long_lived,omitempty"` // Remove active Proxy sessions if the corresponding Task is deleted. JanitorEnabled *bool `json:"janitor_enabled,omitempty"` // The absolute URL of the Flex Flow resource Url *string `json:"url,omitempty"` }
FlexV1FlexFlow struct for FlexV1FlexFlow
type FlexV1Interaction ¶ added in v0.23.0
type FlexV1Interaction struct { // The unique string that identifies the resource Sid *string `json:"sid,omitempty"` // The Interaction's channel Channel *interface{} `json:"channel,omitempty"` // A JSON Object representing the routing rules for the Interaction Channel Routing *interface{} `json:"routing,omitempty"` Url *string `json:"url,omitempty"` Links *map[string]interface{} `json:"links,omitempty"` }
FlexV1Interaction struct for FlexV1Interaction
type FlexV1InteractionChannel ¶ added in v0.23.0
type FlexV1InteractionChannel struct { // The unique string that identifies the resource Sid *string `json:"sid,omitempty"` // The unique string that identifies the resource. InteractionSid *string `json:"interaction_sid,omitempty"` Type *string `json:"type,omitempty"` Status *string `json:"status,omitempty"` // The Twilio error code for a failed channel. ErrorCode *int `json:"error_code,omitempty"` // The error message for a failed channel. ErrorMessage *string `json:"error_message,omitempty"` Url *string `json:"url,omitempty"` Links *map[string]interface{} `json:"links,omitempty"` }
FlexV1InteractionChannel struct for FlexV1InteractionChannel
type FlexV1InteractionChannelInvite ¶ added in v0.23.0
type FlexV1InteractionChannelInvite struct { // The unique string that identifies the resource Sid *string `json:"sid,omitempty"` // The Interaction SID for this Channel InteractionSid *string `json:"interaction_sid,omitempty"` // The Channel SID for this Invite ChannelSid *string `json:"channel_sid,omitempty"` // A JSON object representing the routing rules for the Interaction Channel Routing *interface{} `json:"routing,omitempty"` Url *string `json:"url,omitempty"` }
FlexV1InteractionChannelInvite struct for FlexV1InteractionChannelInvite
type FlexV1InteractionChannelParticipant ¶ added in v0.23.0
type FlexV1InteractionChannelParticipant struct { // The unique string that identifies the resource Sid *string `json:"sid,omitempty"` Type *string `json:"type,omitempty"` // The Interaction Sid for this channel. InteractionSid *string `json:"interaction_sid,omitempty"` // The Channel Sid for this Participant. ChannelSid *string `json:"channel_sid,omitempty"` Url *string `json:"url,omitempty"` }
FlexV1InteractionChannelParticipant struct for FlexV1InteractionChannelParticipant
type FlexV1WebChannel ¶
type FlexV1WebChannel struct { // The SID of the Account that created the resource and owns this Workflow AccountSid *string `json:"account_sid,omitempty"` // The SID of the Flex Flow FlexFlowSid *string `json:"flex_flow_sid,omitempty"` // The unique string that identifies the WebChannel resource Sid *string `json:"sid,omitempty"` // The absolute URL of the WebChannel resource Url *string `json:"url,omitempty"` // The ISO 8601 date and time in GMT when the resource was created DateCreated *time.Time `json:"date_created,omitempty"` // The ISO 8601 date and time in GMT when the resource was last updated DateUpdated *time.Time `json:"date_updated,omitempty"` }
FlexV1WebChannel struct for FlexV1WebChannel
type ListChannelParams ¶
type ListChannelParams struct { // How many resources to return in each list page. The default is 50, and the maximum is 1000. PageSize *int `json:"PageSize,omitempty"` // Max number of records to return. Limit *int `json:"limit,omitempty"` }
Optional parameters for the method 'ListChannel'
func (*ListChannelParams) SetLimit ¶ added in v0.13.0
func (params *ListChannelParams) SetLimit(Limit int) *ListChannelParams
func (*ListChannelParams) SetPageSize ¶
func (params *ListChannelParams) SetPageSize(PageSize int) *ListChannelParams
type ListChannelResponse ¶
type ListChannelResponse struct { FlexChatChannels []FlexV1Channel `json:"flex_chat_channels,omitempty"` Meta ListChannelResponseMeta `json:"meta,omitempty"` }
ListChannelResponse struct for ListChannelResponse
type ListChannelResponseMeta ¶
type ListChannelResponseMeta struct { FirstPageUrl string `json:"first_page_url,omitempty"` NextPageUrl string `json:"next_page_url,omitempty"` Page int `json:"page,omitempty"` PageSize int `json:"page_size,omitempty"` PreviousPageUrl string `json:"previous_page_url,omitempty"` Url string `json:"url,omitempty"` Key string `json:"key,omitempty"` }
ListChannelResponseMeta struct for ListChannelResponseMeta
type ListFlexFlowParams ¶
type ListFlexFlowParams struct { // The `friendly_name` of the Flex Flow resources to read. FriendlyName *string `json:"FriendlyName,omitempty"` // How many resources to return in each list page. The default is 50, and the maximum is 1000. PageSize *int `json:"PageSize,omitempty"` // Max number of records to return. Limit *int `json:"limit,omitempty"` }
Optional parameters for the method 'ListFlexFlow'
func (*ListFlexFlowParams) SetFriendlyName ¶
func (params *ListFlexFlowParams) SetFriendlyName(FriendlyName string) *ListFlexFlowParams
func (*ListFlexFlowParams) SetLimit ¶ added in v0.13.0
func (params *ListFlexFlowParams) SetLimit(Limit int) *ListFlexFlowParams
func (*ListFlexFlowParams) SetPageSize ¶
func (params *ListFlexFlowParams) SetPageSize(PageSize int) *ListFlexFlowParams
type ListFlexFlowResponse ¶
type ListFlexFlowResponse struct { FlexFlows []FlexV1FlexFlow `json:"flex_flows,omitempty"` Meta ListChannelResponseMeta `json:"meta,omitempty"` }
ListFlexFlowResponse struct for ListFlexFlowResponse
type ListInteractionChannelInviteParams ¶ added in v0.23.0
type ListInteractionChannelInviteParams struct { // How many resources to return in each list page. The default is 50, and the maximum is 1000. PageSize *int `json:"PageSize,omitempty"` // Max number of records to return. Limit *int `json:"limit,omitempty"` }
Optional parameters for the method 'ListInteractionChannelInvite'
func (*ListInteractionChannelInviteParams) SetLimit ¶ added in v0.23.0
func (params *ListInteractionChannelInviteParams) SetLimit(Limit int) *ListInteractionChannelInviteParams
func (*ListInteractionChannelInviteParams) SetPageSize ¶ added in v0.23.0
func (params *ListInteractionChannelInviteParams) SetPageSize(PageSize int) *ListInteractionChannelInviteParams
type ListInteractionChannelInviteResponse ¶ added in v0.23.0
type ListInteractionChannelInviteResponse struct { Invites []FlexV1InteractionChannelInvite `json:"invites,omitempty"` Meta ListChannelResponseMeta `json:"meta,omitempty"` }
ListInteractionChannelInviteResponse struct for ListInteractionChannelInviteResponse
type ListInteractionChannelParams ¶ added in v0.23.0
type ListInteractionChannelParams struct { // How many resources to return in each list page. The default is 50, and the maximum is 1000. PageSize *int `json:"PageSize,omitempty"` // Max number of records to return. Limit *int `json:"limit,omitempty"` }
Optional parameters for the method 'ListInteractionChannel'
func (*ListInteractionChannelParams) SetLimit ¶ added in v0.23.0
func (params *ListInteractionChannelParams) SetLimit(Limit int) *ListInteractionChannelParams
func (*ListInteractionChannelParams) SetPageSize ¶ added in v0.23.0
func (params *ListInteractionChannelParams) SetPageSize(PageSize int) *ListInteractionChannelParams
type ListInteractionChannelParticipantParams ¶ added in v0.23.0
type ListInteractionChannelParticipantParams struct { // How many resources to return in each list page. The default is 50, and the maximum is 1000. PageSize *int `json:"PageSize,omitempty"` // Max number of records to return. Limit *int `json:"limit,omitempty"` }
Optional parameters for the method 'ListInteractionChannelParticipant'
func (*ListInteractionChannelParticipantParams) SetLimit ¶ added in v0.23.0
func (params *ListInteractionChannelParticipantParams) SetLimit(Limit int) *ListInteractionChannelParticipantParams
func (*ListInteractionChannelParticipantParams) SetPageSize ¶ added in v0.23.0
func (params *ListInteractionChannelParticipantParams) SetPageSize(PageSize int) *ListInteractionChannelParticipantParams
type ListInteractionChannelParticipantResponse ¶ added in v0.23.0
type ListInteractionChannelParticipantResponse struct { Participants []FlexV1InteractionChannelParticipant `json:"participants,omitempty"` Meta ListChannelResponseMeta `json:"meta,omitempty"` }
ListInteractionChannelParticipantResponse struct for ListInteractionChannelParticipantResponse
type ListInteractionChannelResponse ¶ added in v0.23.0
type ListInteractionChannelResponse struct { Channels []FlexV1InteractionChannel `json:"channels,omitempty"` Meta ListChannelResponseMeta `json:"meta,omitempty"` }
ListInteractionChannelResponse struct for ListInteractionChannelResponse
type ListWebChannelParams ¶
type ListWebChannelParams struct { // How many resources to return in each list page. The default is 50, and the maximum is 1000. PageSize *int `json:"PageSize,omitempty"` // Max number of records to return. Limit *int `json:"limit,omitempty"` }
Optional parameters for the method 'ListWebChannel'
func (*ListWebChannelParams) SetLimit ¶ added in v0.13.0
func (params *ListWebChannelParams) SetLimit(Limit int) *ListWebChannelParams
func (*ListWebChannelParams) SetPageSize ¶
func (params *ListWebChannelParams) SetPageSize(PageSize int) *ListWebChannelParams
type ListWebChannelResponse ¶
type ListWebChannelResponse struct { FlexChatChannels []FlexV1WebChannel `json:"flex_chat_channels,omitempty"` Meta ListChannelResponseMeta `json:"meta,omitempty"` }
ListWebChannelResponse struct for ListWebChannelResponse
type UpdateFlexFlowParams ¶
type UpdateFlexFlowParams struct { // A descriptive string that you create to describe the Flex Flow resource. FriendlyName *string `json:"FriendlyName,omitempty"` // The SID of the chat service. ChatServiceSid *string `json:"ChatServiceSid,omitempty"` // ChannelType *string `json:"ChannelType,omitempty"` // The channel contact's Identity. ContactIdentity *string `json:"ContactIdentity,omitempty"` // Whether the new Flex Flow is enabled. Enabled *bool `json:"Enabled,omitempty"` // IntegrationType *string `json:"IntegrationType,omitempty"` // The SID of the Studio Flow. Required when `integrationType` is `studio`. IntegrationFlowSid *string `json:"Integration.FlowSid,omitempty"` // The URL of the external webhook. Required when `integrationType` is `external`. IntegrationUrl *string `json:"Integration.Url,omitempty"` // The Workspace SID for a new Task. Required when `integrationType` is `task`. IntegrationWorkspaceSid *string `json:"Integration.WorkspaceSid,omitempty"` // The Workflow SID for a new Task. Required when `integrationType` is `task`. IntegrationWorkflowSid *string `json:"Integration.WorkflowSid,omitempty"` // The Task Channel SID (TCXXXX) or unique name (e.g., `sms`) to use for the Task that will be created. Applicable and required when `integrationType` is `task`. The default value is `default`. IntegrationChannel *string `json:"Integration.Channel,omitempty"` // The Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`, not applicable otherwise. IntegrationTimeout *int `json:"Integration.Timeout,omitempty"` // The Task priority of a new Task. The default priority is 0. Optional when `integrationType` is `task`, not applicable otherwise. IntegrationPriority *int `json:"Integration.Priority,omitempty"` // In the context of outbound messaging, defines whether to create a Task immediately (and therefore reserve the conversation to current agent), or delay Task creation until the customer sends the first response. Set to false to create immediately, true to delay Task creation. This setting is only applicable for outbound messaging. IntegrationCreationOnMessage *bool `json:"Integration.CreationOnMessage,omitempty"` // When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to `false`. LongLived *bool `json:"LongLived,omitempty"` // When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to `false`. JanitorEnabled *bool `json:"JanitorEnabled,omitempty"` // The number of times to retry the Studio Flow or webhook in case of failure. Takes integer values from 0 to 3 with the default being 3. Optional when `integrationType` is `studio` or `external`, not applicable otherwise. IntegrationRetryCount *int `json:"Integration.RetryCount,omitempty"` }
Optional parameters for the method 'UpdateFlexFlow'
func (*UpdateFlexFlowParams) SetChannelType ¶
func (params *UpdateFlexFlowParams) SetChannelType(ChannelType string) *UpdateFlexFlowParams
func (*UpdateFlexFlowParams) SetChatServiceSid ¶
func (params *UpdateFlexFlowParams) SetChatServiceSid(ChatServiceSid string) *UpdateFlexFlowParams
func (*UpdateFlexFlowParams) SetContactIdentity ¶
func (params *UpdateFlexFlowParams) SetContactIdentity(ContactIdentity string) *UpdateFlexFlowParams
func (*UpdateFlexFlowParams) SetEnabled ¶
func (params *UpdateFlexFlowParams) SetEnabled(Enabled bool) *UpdateFlexFlowParams
func (*UpdateFlexFlowParams) SetFriendlyName ¶
func (params *UpdateFlexFlowParams) SetFriendlyName(FriendlyName string) *UpdateFlexFlowParams
func (*UpdateFlexFlowParams) SetIntegrationChannel ¶
func (params *UpdateFlexFlowParams) SetIntegrationChannel(IntegrationChannel string) *UpdateFlexFlowParams
func (*UpdateFlexFlowParams) SetIntegrationCreationOnMessage ¶
func (params *UpdateFlexFlowParams) SetIntegrationCreationOnMessage(IntegrationCreationOnMessage bool) *UpdateFlexFlowParams
func (*UpdateFlexFlowParams) SetIntegrationFlowSid ¶
func (params *UpdateFlexFlowParams) SetIntegrationFlowSid(IntegrationFlowSid string) *UpdateFlexFlowParams
func (*UpdateFlexFlowParams) SetIntegrationPriority ¶
func (params *UpdateFlexFlowParams) SetIntegrationPriority(IntegrationPriority int) *UpdateFlexFlowParams
func (*UpdateFlexFlowParams) SetIntegrationRetryCount ¶
func (params *UpdateFlexFlowParams) SetIntegrationRetryCount(IntegrationRetryCount int) *UpdateFlexFlowParams
func (*UpdateFlexFlowParams) SetIntegrationTimeout ¶
func (params *UpdateFlexFlowParams) SetIntegrationTimeout(IntegrationTimeout int) *UpdateFlexFlowParams
func (*UpdateFlexFlowParams) SetIntegrationType ¶
func (params *UpdateFlexFlowParams) SetIntegrationType(IntegrationType string) *UpdateFlexFlowParams
func (*UpdateFlexFlowParams) SetIntegrationUrl ¶
func (params *UpdateFlexFlowParams) SetIntegrationUrl(IntegrationUrl string) *UpdateFlexFlowParams
func (*UpdateFlexFlowParams) SetIntegrationWorkflowSid ¶
func (params *UpdateFlexFlowParams) SetIntegrationWorkflowSid(IntegrationWorkflowSid string) *UpdateFlexFlowParams
func (*UpdateFlexFlowParams) SetIntegrationWorkspaceSid ¶
func (params *UpdateFlexFlowParams) SetIntegrationWorkspaceSid(IntegrationWorkspaceSid string) *UpdateFlexFlowParams
func (*UpdateFlexFlowParams) SetJanitorEnabled ¶
func (params *UpdateFlexFlowParams) SetJanitorEnabled(JanitorEnabled bool) *UpdateFlexFlowParams
func (*UpdateFlexFlowParams) SetLongLived ¶
func (params *UpdateFlexFlowParams) SetLongLived(LongLived bool) *UpdateFlexFlowParams
type UpdateInteractionChannelParams ¶ added in v0.23.0
type UpdateInteractionChannelParams struct { // Status *string `json:"Status,omitempty"` // Optional. The state of associated tasks. If not specified, all tasks will be set to `wrapping`. Routing *interface{} `json:"Routing,omitempty"` }
Optional parameters for the method 'UpdateInteractionChannel'
func (*UpdateInteractionChannelParams) SetRouting ¶ added in v0.23.0
func (params *UpdateInteractionChannelParams) SetRouting(Routing interface{}) *UpdateInteractionChannelParams
func (*UpdateInteractionChannelParams) SetStatus ¶ added in v0.23.0
func (params *UpdateInteractionChannelParams) SetStatus(Status string) *UpdateInteractionChannelParams
type UpdateInteractionChannelParticipantParams ¶ added in v0.23.0
type UpdateInteractionChannelParticipantParams struct { // Status *string `json:"Status,omitempty"` }
Optional parameters for the method 'UpdateInteractionChannelParticipant'
func (*UpdateInteractionChannelParticipantParams) SetStatus ¶ added in v0.23.0
func (params *UpdateInteractionChannelParticipantParams) SetStatus(Status string) *UpdateInteractionChannelParticipantParams
type UpdateWebChannelParams ¶
type UpdateWebChannelParams struct { // ChatStatus *string `json:"ChatStatus,omitempty"` // The post-engagement data. PostEngagementData *string `json:"PostEngagementData,omitempty"` }
Optional parameters for the method 'UpdateWebChannel'
func (*UpdateWebChannelParams) SetChatStatus ¶
func (params *UpdateWebChannelParams) SetChatStatus(ChatStatus string) *UpdateWebChannelParams
func (*UpdateWebChannelParams) SetPostEngagementData ¶
func (params *UpdateWebChannelParams) SetPostEngagementData(PostEngagementData string) *UpdateWebChannelParams
Source Files ¶
- api_service.go
- channels.go
- configuration.go
- flex_flows.go
- interactions.go
- interactions_channels.go
- interactions_channels_invites.go
- interactions_channels_participants.go
- model_flex_v1_channel.go
- model_flex_v1_configuration.go
- model_flex_v1_flex_flow.go
- model_flex_v1_interaction.go
- model_flex_v1_interaction_channel.go
- model_flex_v1_interaction_channel_invite.go
- model_flex_v1_interaction_channel_participant.go
- model_flex_v1_web_channel.go
- model_list_channel_response.go
- model_list_channel_response_meta.go
- model_list_flex_flow_response.go
- model_list_interaction_channel_invite_response.go
- model_list_interaction_channel_participant_response.go
- model_list_interaction_channel_response.go
- model_list_web_channel_response.go
- web_channels.go