All Classes and Interfaces
Class
Description
Base class for SVAML Action
The phone number that has been rented by a customer and assigned to a project.
Dedicated Builder
Parameters request to list active numbers for a project
Lists all active numbers for a project
The phone number that has been rented by a customer and assigned to a project.
Dedicated Builder
Physical addresses of the contact.
Dedicated Builder
Represents an agent that is involved in a conversation.
Dedicated Builder
Agent Joined Event Type
Dedicated Builder
Agent Left Event Type
Dedicated Builder
Agent's classification.
If Answering Machine Detection (see AMD) is enabled, this
object contains information about whether the call was answered by a machine.
The reason that the system used to determine who answered the call.
The status of a call
The analysis provided by the Smart Conversations machine learning engine(s).
Dedicated Builder
This callback is made when the call is picked up by the callee (person receiving the call).
Exception related to server authentication
Base Sinch Client API exception
APIException Builder helper to transform dedicated domains error response to Exception
Sinch Client exception related to payload parsing/mapping error
The request sent to the API endpoint to create a new app.
Dedicated Builder
Base class for all classes supported by AppEvent
If you are including the AppleBC channel in the
channel_identifier property, you
must include this object.Dedicated Builder
Information about your number.
Credentials related to Voice/Verification authentication
Dedicated Builder
Request parameters when updating a numbers list
You can use the API to manage features of applications in your project.
primary and if configured fallback callback URLs for an application
Message originating from an app
Dedicated Builder
Base class for all classes supported by AppMessageBody
The response showing information about the app.
Dedicated Builder
Applications related service
The request sent to the API endpoint to update the configuration of an app.
Dedicated Builder
Get information about your numbers.
The phone numbers that are available to be rented in the Sinch Customer Dashboard or via the
public numbers API.
Dedicated Builder
Parameters request to list available numbers for a project
Lists all available numbers for a project
Request message for searching and renting in one go any number that matches the search criteria.
Dedicated Builder
Request message for renting a phone number.
Dedicated Builder
A region for which numbers are provided.
Dedicated Builder
Parameters request to list all regions by criteria
Lists all available numbers for a project
Available Region Service
Base class for Batch types
Base class for Delivery Report WebHook
It consists of a username and a password.
Dedicated Builder
Base class for Batch types
BatchBinary type
Parameters request to list batches for a project
Lists batches response
Batches Service
BatchMedia type
BatchText type
Response message containing the callbacks configuration for a specific project
Dedicated Builder
Callback Configuration Service
The request to update the callbacks configuration for the current project
Dedicated Builder
This object contains additional settings related to callback processing.
Dedicated Builder
Returns any callback URLs configured for the specified application
Base class for webhooks call event
Information related to a specific call
Specifies which part of the call will be managed.
Message for triggering a call.
Dedicated Builder
The conference callout calls a phone number or a user.
The custom callout, the server initiates a call from the servers that can be controlled by
specifying how the call should progress at each call event.
The text-to-speech callout calls a phone number and plays a synthesized text messages or
pre-recorded sound files.
A callout is a call made to a phone number or app using the API.
Describe the reason why a call ended
Describe the result of a call
Using the Calls service, you can manage on-going calls or retrieve information about a call.
The status of a call
Capability of a phone number
This callback is used to deliver the results of the asynchronous capability checks.
Dedicated Builder
CapabilityEventNotification
Dedicated Builder
Status indicating the recipient's capability on the channel.
Service for working with capability
CapabilityType of a phone number
You can set the desired size of the card in the message.
Field containing a Card Message
Dedicated Builder
A message containing an image media component.
Dedicated Builder
Message containing a list of cards often rendered horizontally on supported channels.
Dedicated Builder
Base class for Credentials classes
This callback is used to deliver notifications regarding channel-specific information and
updates.
Dedicated Builder
ChannelEventNotification
Dedicated Builder
A unique identity of message recipient on a particular channel.
Dedicated Builder
State of the channel credentials integration.
Dedicated Builder
Status of the channel credentials integration
Container for list of specific channel identities
Dedicated Builder
ChannelRecipientIdentity
Dedicated Builder
A contact message containing a channel specific message (not supported by OMNI types).
Dedicated Builder
The message type.
Base class for all classes supported by ChannelSpecificContactMessageContent
Base class for all classes supported by ChannelSpecificMessage
ChannelTemplateOverride
Dedicated Builder
Base class for message containing choices/actions.
Dedicated Builder
Choice call message
Dedicated Builder
A message component for interactive messages, containing a choice.
Dedicated Builder
Choice location message
Dedicated Builder
Message containing choices/actions.
Dedicated Builder
Base class for message supporting ChoiceMessageType
Represents a response to a choice message.
Dedicated Builder
Choice text message
Dedicated Builder
Choice URL message
Dedicated Builder
Optional.
Dedicated Builder
Comment Event Type
Dedicated Builder
Either LIVE or FEED.
Comment Reply Event Type
Dedicated Builder
Composing End Event Type
Dedicated Builder
Composing
Dedicated Builder
Options to control how DTMF signals are used by the participant in the conference.
Action to apply on conference participant"
Use to configure conference participant settings
Information about a conference's participant
Using the Conferences endpoint, you can perform tasks like retrieving information about an
on-going conference, muting or unmuting participants, or removing participants from a conference.
Configuration used by Sinch Client
Dedicated Builder
A participant in a conversation typically representing a person.
Dedicated Builder
This callback is sent when a new contact is created.
Dedicated Builder
A participant in a conversation typically representing a person.
Dedicated Builder
This callback is sent when a new contact is deleted.
Dedicated Builder
Base class for all classes supported by ContactEvent
Contact ID
Dedicated Builder
This callback is sent when duplicates of channel identities are found between multiple contacts
in the contact database during message and event processing.
Dedicated Builder
Message containing contact information.
Dedicated Builder
Contact Info Message
Dedicated Builder
Gets or Sets ContactLanguage
Lists all contacts
This callback is sent when two contacts are merged.
Dedicated Builder
ContactMergeEventNotification
Dedicated Builder
Message originating from a Contact
Dedicated Builder
Base class for all classes supported by ContactMessageBody
Base class for all classes supported by ContactMessageEvent
ContactNotification
Dedicated Builder
Contact related service
This callback is sent when a new contact is updated.
Dedicated Builder
Base class related to a control
Control URL used during a custom callout
A collection of messages exchanged between a contact and an app.
Dedicated Builder
The identifier of the channel you want to include.
Enables access to the underlying messaging channel.
Dedicated Builder
Factory helper for App credentials builder
Execution context related to Conversation domains
Dedicated Builder
Conversation Deleted Event Type
Dedicated Builder
This callback is sent when a conversation between the subscribed app and a contact is deleted.
Dedicated Builder
Gets or Sets ConversationDirection
An event on a particular channel.
Dedicated Builder
Common properties to ConversationEvent management
Dedicated Builder
Gets or Sets ConversationMergeStrategy
Message originating from a Conversation
Dedicated Builder
Base class for all classes supported by ConversationMessageBody
Gets or Sets ConversationMessagesView
NONE - Omit metadata.
Object containing the details of the started / stopped / deleted conversation
Dedicated Builder
ConversationRecentMessage
Dedicated Builder
Conversation Region
Conversation Service V1
Conversation Service
Parameters request to list recent messages from a conversation
Dedicated builder
Recent messages and conversation response
Parameters request to list messages
Lists all conversations response
Service for working with the conversation log
This callback is sent when a new conversation between the subscribed app and a contact is
started.
Dedicated Builder
This callback is sent when a conversation between the subscribed app and a contact is stopped.
Dedicated Builder
ConversationWebhookEvent
Dedicated Builder
Geographic coordinates
Dedicated Builder
The conversation to create.
Dedicated Builder
Cursor Based Page Navigator
Utility class for Date
This object contains additional settings related to delivery
report based fallback.
Dedicated Builder
Common Definition to Delivery Report
Parameters request to get a Batch Delivery Report
MMS delivery Report
SMS delivery Report
Applied encoding for message.
Parameters request to list delivery reports for a project
Common Definition to Delivery Report
Applied encoding for message.
SMS Delivery Report Recipient for MMS
SMS Delivery Report Recipient for SMS
Lists batches response
Delivery reports Service.
The status field describes which state a particular message is in.
Details related to a delivery report status
DeliveryReportType authorized values
Shows the status of the message or event delivery
Can be of type number for PSTN endpoints or of type username for data endpoints.
Destination of numbers type
Destination types
Destination of type SIP
Destination of type username for data endpoints.
This callback is made when the call is disconnected.
The retention policy configured for messages in Dispatch Mode.
Dedicated Builder
Gets or Sets DispatchRetentionPolicyType
An object containing a result object that reports on all identified fields, as well as the values
assigned to those fields.
Dedicated Builder
DocumentFieldClassificationData
Dedicated Builder
An object that identifies a document type within the image, along with a confidence level for
that document type.
Dedicated Builder
Domains type
Information related to a dryRun request
Details related to a dryRun recipient
Determines what DTMF mode the participant will use in the call.
DTMF played to the callee.
DuplicatedIdentities
Dedicated Builder
E164 Phone Number representation class helper
Email addresses of the contact.
Dedicated Builder
Abstract class providing common definition to extendable enums
Utility class to manage extendable enumeration set
Event
Dedicated Builder
The direction of the event.
EventDeliveryReceiptEvent
Dedicated Builder
EventDeliveryReport
Dedicated Builder
Parameters request to list events
Dedicated Builder
Lists all messages response
Service for working with the Events
Fallback message.
Dedicated Builder
A message type for sending WhatsApp Flows.
Dedicated Builder
Gets or Sets flowAction
The mode in which the flow is.
FlowChannelSpecificMessageFlowActionPayload
Dedicated Builder
Generic Type
Dedicated Builder
The channel.
GetChannelProfileRequest
Dedicated Builder
GetChannelProfileResponse
Dedicated Builder
Parameters request to create a group
Parameters request to replace a group
Parameters request to list groups
Groups List response
Groups Service
Parameters request to update" a group
Base class for Identity objects
Base class for Incoming message
Incoming SMS Binary
InboundEvent
Dedicated Builder
Parameters request to list delivery reports for a project
List Incoming Messages response
Inbounds Service
Incoming SMS Text
This event, called the ICE event, can be triggered by either an incoming data call or an incoming
PSTN call.
Domains type
Inject Event request
Dedicated Builder
InjectEventResponse
Dedicated Builder
Message to be injected
Dedicated Builder
A message on a particular channel.
Dedicated Builder
If you are including the INSTAGRAM channel in the
channel_identifier property, you
must include this object.Dedicated Builder
IntentResult
Dedicated Builder
If you are including the KakaoTalkChat channel in the
channel_identifier property,
you must include this object.Dedicated Builder
If you are including the KakaoTalk channel in the
channel_identifier property, you
must include this object.Dedicated Builder
If you are including the LINE channel in the
channel_identifier property, you must
include this object.Dedicated Builder
Available methods and actions which can be done after a successful Verification
Dedicated Builder
The related action that can be performed on the initiated Verification.
Additional properties for the message.
Dedicated Builder
ListAppsResponse
Dedicated Builder
ListContactsResponse
Dedicated Builder
Base class for all classes supported by ListItem
A message containing a list of options to choose from
Dedicated Builder
Abstract class used for handling unified paginated response
Section for interactive WhatsApp messages containing ListItem
Dedicated Builder
ListWebhooksResponse
Dedicated Builder
Message containing geographic location.
Dedicated Builder
MachineLearningImageRecognitionResult
Dedicated Builder
MachineLearningNLUResult
Dedicated Builder
An object that contains the PII analysis of the corresponding messages.
Dedicated Builder
MachineLearningSentimentResult
Dedicated Builder
MediaBody object
A message containing a media component, such as an image or video.
Dedicated Builder
A message containing a media component, such as an image, document, or video.
Dedicated Builder
The type of information that's returned
Navigates to the named menu
Menu Action type
The type of input received.
MergeContactRequest
Dedicated Builder
This callback notifies the API clients about status changes of already sent app message.
Dedicated Builder
MessageDeliveryReport
Dedicated Builder
This callback delivers contact (end-user) messages to the API clients.
Dedicated Builder
MessageInboundEventMessage
Dedicated Builder
The direction of the message, it's always TO_APP for contact messages.
This callback delivers contact (end-user) messages to the API clients.
Dedicated Builder
Select the priority type for the message
This object contains settings related to message retry mechanism.
Dedicated Builder
Parameters request to list messages
Dedicated Builder
Lists all messages response
Messages related service
Specifies the message source for which the request will be processed.
This callback provides a notification to the API clients that the corresponding app message was
submitted to a channel.
Dedicated Builder
MessageSubmitEventMessage
Dedicated Builder
Update message request
Dedicated Builder
Update strategy for the
conversation_metadata field.If you are including the MMS channel in the
channel_identifier property, you must
include this object.Dedicated Builder
An object giving details on currency code and the amount charged.
Dedicated Builder
Means "music-on-hold."
Name information of the contact.
Dedicated Builder
This is the general callback used to send notifications.
NumberEvent
Dedicated Builder
The type of the event.
If the status is FAILED, a failure code will be provided.
The status of the event.
Identity based onto a phone number
Dedicated Builder
Detailed information about a number
Execution context related to Numbers domains
Dedicated Builder
Numbers Service
Numbers Service
Type of phone number
The type of the number
OffensiveAnalysis
Dedicated Builder
A label, either SAFE or UNSAFE, that classifies the analyzed content.
Base class for all classes supported by OmniMessageOverride
An object containing a result array that reports the machine learning engine's character
extraction results.
Dedicated Builder
OpticalCharacterRecognitionData
Dedicated Builder
This callback is used to deliver opt-in notifications from the channels.
Dedicated Builder
OptInEventNotification
Dedicated Builder
Status of the opt-in registration.
This field is populated if the opt-in failed.
Dedicated Builder
class adapted from
Optional enabling to:
accept null value as authorized and defined value
determine is a value was set with any value (null included) or not
This callback is used to deliver opt-out notifications from the channels.
Dedicated Builder
OptOutEventNotification
Dedicated Builder
Status of the opt-out registration.
This field is populated if the opt-out failed.
Dedicated Builder
Supported fields for ordering
Organization information of the contact.
Dedicated Builder
Utility class to manage a pair of information (tuple)
Status reflecting how payment flow goes
Payment Status Update
Dedicated Builder
Group of statuses of the user-initiated transaction changes.
Text-To-Speech engine settings
Dedicated Builder
Phone numbers of the contact.
Dedicated Builder
Price
Dedicated Builder
Whether or not Conversation API should store contacts and conversations for the app.
Overrides the app's Processing Mode.
A message component for interactive messages, containing a product.
Dedicated Builder
Represents an interactive WhatsApp message containing ProductItem objects
Dedicated Builder
This callback is triggered as a result of a
runMenu action.The provisioning status.
QueryCapabilityRequest
Dedicated Builder
An CapabilityResponse contains the identity of the recipient for which will be perform a
capability lookup.
Dedicated Builder
Information related to a number
QueueStats
Dedicated Builder
RateLimits
Dedicated Builder
Type of action
Reaction
Dedicated Builder
Reason
Dedicated Builder
Gets or Sets ReasonCode
Gets or Sets ReasonSubCode
Base class for all classes supported by Recipient
RecordNotificationEvent
Dedicated Builder
RecordNotificationEventNotification
Dedicated Builder
Record status for a specific entity
If the contact message was a response to a previous App message then this field contains
information about that.
Dedicated Builder
The type of the resource.
The retention policy configured for the app.
Dedicated Builder
Gets or Sets RetentionPolicyType
Represents the ongoing or failed scheduled provisioning job.
Dedicated Builder
ScheduledVoiceProvisioning
Dedicated Builder
ScheduledVoiceProvisioningEST
Dedicated Builder
ScheduledVoiceProvisioningFAX
Dedicated Builder
ScheduledVoiceProvisioningRTC
Dedicated Builder
SearchPattern
Dedicated Builder
The pattern to apply to searches
SendEventRequest
Dedicated Builder
SendEventResponse
Dedicated Builder
This is the request body for sending a message.
Dedicated Builder
SendMessageResponse
Dedicated Builder
The most probable sentiment of the analyzed text.
SentimentResult
Dedicated Builder
Class used to store server related information and configuration
Short Link Activated
Dedicated Builder
Sinch Sdk Client implementation
This object is required for apps that subscribe to Smart Conversations features.
Dedicated Builder
When using the Smart Conversations functionality, Machine Learning and Artificial Intelligence
analyses are delivered through specific callbacks on the Conversation API.
Dedicated Builder
SmartConversationsEventNotification
Dedicated Builder
The current SMS configuration for this number.
Dedicated Builder
Execution context related to Voice domains
Dedicated Builder
The error codes that show the reason of failure of a scheduled provisioning
SMS Region
SMS Service
Credentials related to SMS authentication based onto service plan
Dedicated Builder
This object is required for channels which use a bearer-type of credential for authentication.
Dedicated Builder
This object is required for channels which use a static token credential for authentication.
Dedicated Builder
The type of the call result.
Prices associated with this verification
Dedicated Builder
With the PIN SMS verification method, a user's phone number is verified by sending an SMS
containing a PIN code that must be manually returned.
Utility class for string
Class enabling to define SVAML actions and instructions
If you are including the Telegram Bot channel in the
channel_identifier property,
you must include this object.Dedicated Builder
Gets or Sets typeChannel
Template Message
Dedicated Builder
Template (Reference)
Dedicated Builder
Service for working with Conversation templates
Templates V1
Templates V2
TemplateTranslation
Message to be injected
Dedicated Builder
Dedicated Builder
TemplateTranslationBase
Dedicated Builder
TemplateV1
Dedicated Builder
TemplateV2
Dedicated Builder
TemplateVariable
Dedicated Builder
A message containing only text.
Dedicated Builder
Token Based Page Navigator
TranscodeMessageRequest
Dedicated Builder
TranscodeMessageResponse
Dedicated Builder
Service for working with transcoding
Parameters request to list translation relate to a template
Transport Protocol type
Credentials related to unified Sinch authentication
Dedicated Builder
Some of the callbacks received from the underlying channels might be specific to a single channel
or may not have a proper mapping in Conversation API yet.
Dedicated Builder
UnsupportedCallbackEventCallback
Dedicated Builder
Base class for Batch types
A URL/website
Dedicated Builder
A generic URL message.
Dedicated Builder
Execution context related to Verification domains
Dedicated Builder
VerificationEvent
Dedicated Builder
Determines whether the verification can be executed.
The type of the verification request.
Base class to all Verification Report requests
Flash Call Verification Report Request
Dedicated Builder
The type of verification.
Phone Call Verification Report Request
Dedicated Builder
The type of verification.
SMS Verification Report Request
Dedicated Builder
The type of verification.
VerificationReportResponse
Dedicated Builder
VerificationReportResponseFlashCall
Dedicated Builder
VerificationReportResponsePhoneCall
Dedicated Builder
VerificationReportResponseSms
Dedicated Builder
Verification Report Service
VerificationRequestEvent
Dedicated Builder
The type of the event.
The verification method.
VerificationRequestEventResponse
Dedicated Builder
Flash Call Request Event Response
Dedicated Builder
Phone Call Request Event Response
Dedicated Builder
SMS Request Event Response
Dedicated Builder
VerificationResultEvent
Dedicated Builder
The type of the event.
Verification Domain Level Service
Verification Domain Level Service
VerificationStartRequest
Dedicated Builder
VerificationStartRequestData
Dedicated Builder
VerificationStartRequestFlashCall
Dedicated Builder
VerificationStartRequestPhoneCall
Dedicated Builder
VerificationStartRequestSms
Dedicated Builder
Accepted values for the type of code to be generated are Numeric, Alpha, and Alphanumeric.
VerificationStartResponse
Dedicated Builder
Data Response
Dedicated Builder
Flash Call Response
Dedicated Builder
Phone Call Response
Dedicated Builder
SMS Response
Dedicated Builder
Verification Start Service
The status of the verification
Displays the reason why a verification has
FAILED, was DENIED, or was
ABORTED.Verification Status Response Common Fields
Dedicated Builder
Flash Call Verification Status Response
Dedicated Builder
The method of the verification request.
Phone Call Verification Status Response
Dedicated Builder
The method of the verification request.
SMS Verification Status Response
Dedicated Builder
The method of the verification request.
Prices associated with this verification
Dedicated Builder
Get the status of specific verification requests in the verification process.
Common VoiceConfiguration fields
Dedicated Builder
EST VoiceConfiguration
Dedicated Builder
FAX VoiceConfiguration
Dedicated Builder
RTC VoiceConfiguration
Dedicated Builder
Execution context related to Voice domains
Dedicated Builder
The Calling API uses a variety of endpoints depending on where in the world you are located.
Voice service
Represents a destination for receiving callbacks from the Conversation API.
Dedicated Builder
Interface defining a WebHook event
Webhooks service
Webhooks service
WebHooks
Webhooks service
Webhooks service
Gets or Sets WebhookTargetType
Each webhook can subscribe to one or more of the following triggers
If you are including the WeChat channel in the
channel_identifier property, you must
include this object.Dedicated Builder
Body of the interactive message.
Dedicated Builder
Footer of the interactive message.
Dedicated Builder
Base class for all classes supported by WhatsAppInteractiveHeader
Header of the interactive message with document.
Dedicated Builder
Gets or Sets type
Header of the interactive message with image.
Dedicated Builder
Gets or Sets type
Media object for the header.
Dedicated Builder
Header of the interactive message with text.
Dedicated Builder
Gets or Sets type
Header of the interactive message with video.
Dedicated Builder
Gets or Sets type
The interactive nfm reply message.
Dedicated Builder
The nfm reply message type.
A WhatsApp interactive contact message containing the nfm_reply.
Dedicated Builder
The interactive message type.