sakari.sms
Module sakari.sms
API
Definitions
ballerinax/sakari.sms Ballerina library
Overview
Sakari is a business messaging platform for sending and tracking SMS and MMS at scale. This connector lets you manage the contacts, messages, conversations, templates, campaigns, drip campaigns, autoresponders, tracked links and webhooks of a Sakari account from Ballerina. It supports version 1 of the Sakari REST API and authenticates with the OAuth 2.0 client-credentials grant.
Key features
- Create, update and delete contacts, or upload many at once
- Send SMS and MMS messages and track their delivery status
- Read conversations and the messages inside them
- Manage message templates, campaigns, drip campaigns and autoresponders
- Subscribe to message and contact events through webhooks
Setup guide
To use the Sakari SMS connector you need a Sakari account and API credentials.
-
Sign in to your Sakari account.
-
Open the API settings of your account and create API credentials. Note the client ID and the client secret.
-
Note the ID of the account the connector will work with. Every operation takes it as the
accountIdargument. -
Keep the credentials out of the source code, for example in a
Config.tomlfile.
Quickstart
To use the sakari.sms connector in your Ballerina application, update the .bal file as follows:
Step 1: Import the module
import ballerinax/sakari.sms;
Step 2: Create a Config.toml file
clientId = "<client id>" clientSecret = "<client secret>" accountId = "<account id>"
Step 3: Create a new client
configurable string clientId = ?; configurable string clientSecret = ?; configurable string accountId = ?; sms:Client sakari = check new ({auth: {clientId, clientSecret}});
Step 4: Invoke the connector operation
public function main() returns error? { sms:BalanceResponse _ = check sakari->getBalance(accountId); }
Examples
The Sakari SMS connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
- Welcome message campaign - Add a customer, save a welcome template and optionally send the welcome text.
- Inbox activity review - Check the balance and review the latest messages of recent conversations.
Clients
sakari.sms: Client
Sakari is a business messaging platform for sending and tracking SMS and MMS at scale. This connector manages contacts, messages, conversations, templates, campaigns, drip campaigns, autoresponders, tracked links and webhooks in a Sakari account.
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.sakari.io/v1" - URL of the target service
getBalance
Fetch account balance
Parameters
- accountId string - Account to apply operations to
Return Type
- BalanceResponse|error - The account balance
listAutoresponders
function listAutoresponders(string accountId, map<string|string[]> headers) returns AutorespondersResponse|errorFetch All Account Autoresponders
Parameters
- accountId string - Account to apply operations to
Return Type
- AutorespondersResponse|error - The account's autoresponders
createAutoresponder
function createAutoresponder(string accountId, AutoresponderRequest payload, map<string|string[]> headers) returns AutoresponderResponse|errorCreate an Autoresponder
Parameters
- accountId string - Account to apply operations to
- payload AutoresponderRequest - Autoresponder to create
Return Type
- AutoresponderResponse|error - The created autoresponder
getAutoresponder
function getAutoresponder(string accountId, string autoresponderId, map<string|string[]> headers) returns AutoresponderResponse|errorFetch An Account Autoresponder
Parameters
- accountId string - Account to apply operations to
- autoresponderId string - Autoresponder to apply operations to
Return Type
- AutoresponderResponse|error - The requested autoresponder
updateAutoresponder
function updateAutoresponder(string accountId, string autoresponderId, AutoresponderRequest payload, map<string|string[]> headers) returns AutoresponderResponse|errorUpdate An Autoresponder
Parameters
- accountId string - Account to apply operations to
- autoresponderId string - Autoresponder to apply operations to
- payload AutoresponderRequest - Autoresponder fields to update
Return Type
- AutoresponderResponse|error - The updated autoresponder
deleteAutoresponder
function deleteAutoresponder(string accountId, string autoresponderId, map<string|string[]> headers) returns BasicResponse|errorRemove an autoresponder
Parameters
- accountId string - Account to apply operations to
- autoresponderId string - Autoresponder to apply operations to
Return Type
- BasicResponse|error - Confirmation that the autoresponder was removed
listAvailablePhoneNumbers
function listAvailablePhoneNumbers(string accountId, map<string|string[]> headers, *ListAvailablePhoneNumbersQueries queries) returns AvailablePhoneNumbersResponse|errorCheck all available phone numbers
Parameters
- accountId string - Account to apply operations to
- queries *ListAvailablePhoneNumbersQueries - Queries to be sent with the request
Return Type
- AvailablePhoneNumbersResponse|error - The phone numbers available to add to the account
listContacts
function listContacts(string accountId, map<string|string[]> headers, *ListContactsQueries queries) returns ContactsResponse|errorFetch contacts
Parameters
- accountId string - Account to apply operations to
- queries *ListContactsQueries - Queries to be sent with the request
Return Type
- ContactsResponse|error - A page of contacts matching the filters
createContact
function createContact(string accountId, ContactRequest payload, map<string|string[]> headers, *CreateContactQueries queries) returns CreateContactResponse|errorCreate contact
Parameters
- accountId string - Account to apply operations to
- payload ContactRequest - Contact to create, as JSON, or a CSV file of contacts to upload
- queries *CreateContactQueries - Queries to be sent with the request
Return Type
- CreateContactResponse|error - The created contacts, or a summary of the uploaded contacts
getContact
function getContact(string accountId, string contactId, map<string|string[]> headers) returns ContactResponse|errorFetch contact by ID
Parameters
- accountId string - Account to apply operations to
- contactId string - ID of contact to return
Return Type
- ContactResponse|error - The requested contact
updateContact
function updateContact(string accountId, string contactId, ContactRequest payload, map<string|string[]> headers) returns ContactResponse|errorUpdates a contact
Parameters
- accountId string - Account to apply operations to
- contactId string - ID of contact
- payload ContactRequest - Contact fields to update
Return Type
- ContactResponse|error - The updated contact
deleteContact
function deleteContact(string accountId, string contactId, map<string|string[]> headers) returns SuccessResponse|errorDeletes a contact
Return Type
- SuccessResponse|error - Confirmation that the contact was deleted
listMessages
function listMessages(string accountId, map<string|string[]> headers, *ListMessagesQueries queries) returns MessagesResponse|errorFetch messages
Parameters
- accountId string - Account to apply operations to
- queries *ListMessagesQueries - Queries to be sent with the request
Return Type
- MessagesResponse|error - A page of messages matching the filters
sendMessages
function sendMessages(string accountId, SendMessagesRequest payload, map<string|string[]> headers) returns SendMessagesResponse|errorSend Messages
Parameters
- accountId string - Account to apply operations to
- payload SendMessagesRequest - Message to send and the recipients to send it to
Return Type
- SendMessagesResponse|error - A summary of the messages queued for sending
getMessage
function getMessage(string accountId, string messageId, map<string|string[]> headers) returns MessageResponse|errorFetch message by id
Parameters
- accountId string - Account to apply operations to
- messageId string - ID of message to return
Return Type
- MessageResponse|error - The requested message
listTemplates
function listTemplates(string accountId, map<string|string[]> headers, *ListTemplatesQueries queries) returns TemplatesResponse|errorFetch templates
Parameters
- accountId string - Account to apply operations to
- queries *ListTemplatesQueries - Queries to be sent with the request
Return Type
- TemplatesResponse|error - A page of templates matching the filters
createTemplate
function createTemplate(string accountId, Template payload, map<string|string[]> headers) returns TemplateResponse|errorCreate template
Return Type
- TemplateResponse|error - The created template
getTemplate
function getTemplate(string accountId, string templateId, map<string|string[]> headers) returns TemplateResponse|errorFetch template by ID
Parameters
- accountId string - Account to apply operations to
- templateId string - ID of template to return
Return Type
- TemplateResponse|error - The requested template
updateTemplate
function updateTemplate(string accountId, string templateId, Template payload, map<string|string[]> headers) returns TemplateResponse|errorUpdates a template
Parameters
- accountId string - Account to apply operations to
- templateId string - ID of template
- payload Template - Template fields to update
Return Type
- TemplateResponse|error - The updated template
deleteTemplate
function deleteTemplate(string accountId, string templateId, map<string|string[]> headers) returns SuccessResponse|errorDeletes a template
Parameters
- accountId string - Account to apply operations to
- templateId string - Template id to delete
Return Type
- SuccessResponse|error - Confirmation that the template was deleted
listCampaigns
function listCampaigns(string accountId, map<string|string[]> headers, *ListCampaignsQueries queries) returns CampaignsResponse|errorFetch campaigns
Parameters
- accountId string - Account to apply operations to
- queries *ListCampaignsQueries - Queries to be sent with the request
Return Type
- CampaignsResponse|error - A page of campaigns matching the filters
createCampaign
function createCampaign(string accountId, CampaignRequest payload, map<string|string[]> headers) returns CampaignResponse|errorCreate campaign
Parameters
- accountId string - Account to apply operations to
- payload CampaignRequest - Campaign to create
Return Type
- CampaignResponse|error - The created campaign
createAndExecuteCampaign
function createAndExecuteCampaign(string accountId, QuickCampaignRequest payload, map<string|string[]> headers) returns QuickCampaignResponse|errorCreate and Execute a campaign
Parameters
- accountId string - Account to apply operations to
- payload QuickCampaignRequest - Campaign to create and execute
Return Type
- QuickCampaignResponse|error - The created campaign and its execution
getCampaign
function getCampaign(string accountId, string campaignId, map<string|string[]> headers) returns CampaignResponse|errorFetch campaign by ID
Parameters
- accountId string - Account to apply operations to
- campaignId string - ID of campaign to return
Return Type
- CampaignResponse|error - The requested campaign
updateCampaign
function updateCampaign(string accountId, string campaignId, CampaignRequest payload, map<string|string[]> headers) returns CampaignResponse|errorUpdates a campaign
Parameters
- accountId string - Account to apply operations to
- campaignId string - ID of campaign
- payload CampaignRequest - Campaign fields to update
Return Type
- CampaignResponse|error - The updated campaign
deleteCampaign
function deleteCampaign(string accountId, string campaignId, map<string|string[]> headers) returns SuccessResponse|errorDeletes a campaign
Parameters
- accountId string - Account to apply operations to
- campaignId string - Campaign id to delete
Return Type
- SuccessResponse|error - Confirmation that the campaign was deleted
listConversations
function listConversations(string accountId, map<string|string[]> headers, *ListConversationsQueries queries) returns ConversationsResponse|errorFetch conversations
Parameters
- accountId string - Account to apply operations to
- queries *ListConversationsQueries - Queries to be sent with the request
Return Type
- ConversationsResponse|error - A page of conversations
getConversation
function getConversation(string accountId, string conversationId, map<string|string[]> headers) returns ConversationResponse|errorFetch conversation by ID
Parameters
- accountId string - Account to apply operations to
- conversationId string - ID of conversation to return
Return Type
- ConversationResponse|error - The requested conversation
closeConversation
function closeConversation(string accountId, string conversationId, map<string|string[]> headers) returns ConversationResponse|errorCloses a conversation
Parameters
- accountId string - Account to apply operations to
- conversationId string - ID of conversation
Return Type
- ConversationResponse|error - The closed conversation
listLinks
function listLinks(string accountId, map<string|string[]> headers, *ListLinksQueries queries) returns LinksResponse|errorFetch links
Parameters
- accountId string - Account to apply operations to
- queries *ListLinksQueries - Queries to be sent with the request
Return Type
- LinksResponse|error - A page of tracked links matching the search
getLink
function getLink(string accountId, string linkId, map<string|string[]> headers) returns LinkResponse|errorFetch link by ID
Return Type
- LinkResponse|error - The requested tracked link
deleteLink
Delete link by ID
Return Type
- error? - Confirmation that the tracked link was deleted
listLinkSources
function listLinkSources(string accountId, string linkId, map<string|string[]> headers, *ListLinkSourcesQueries queries) returns LinkSourcesResponse|errorFetch link sources
Parameters
- accountId string - Account to apply operations to
- linkId string - ID of link
- queries *ListLinkSourcesQueries - Queries to be sent with the request
Return Type
- LinkSourcesResponse|error - The click sources of the tracked link
getLinkSource
function getLinkSource(string accountId, string linkId, string sourceId, map<string|string[]> headers) returns LinkSourceResponse|errorFetch link source by ID
Parameters
- accountId string - Account to apply operations to
- linkId string - ID of link to return
- sourceId string - Source to analyse
Return Type
- LinkSourceResponse|error - The requested link source
getLinkSourceStats
function getLinkSourceStats(string accountId, string linkId, string sourceId, map<string|string[]> headers) returns LinkSourceStatsResponse|errorFetch link source statistics by ID
Parameters
- accountId string - Account to apply operations to
- linkId string - ID of link to return
- sourceId string - Source to analyse
Return Type
- LinkSourceStatsResponse|error - Click statistics over time for the link source
shareFile
function shareFile(byte[] payload, map<string|string[]> headers) returns ShareFileResponse|errorShare file - use to host a file and generate a short link to be used directly in a message or as a link to media for a MMS
Parameters
- payload byte[] - File to share
Return Type
- ShareFileResponse|error - The short link to the shared file
listWebhooks
function listWebhooks(string accountId, map<string|string[]> headers) returns WebhooksResponse|errorFetch active webhooks
Parameters
- accountId string - Account to apply operations to
Return Type
- WebhooksResponse|error - The account's webhook subscriptions
subscribeWebhook
function subscribeWebhook(string accountId, SubscribeWebhookRequest payload, map<string|string[]> headers) returns WebhookResponse|errorSubscribe to message events
Parameters
- accountId string - Account to apply operations to
- payload SubscribeWebhookRequest - Callback URL and the event types to subscribe to
Return Type
- WebhookResponse|error - The created webhook subscription
unsubscribeWebhook
function unsubscribeWebhook(string accountId, string url, map<string|string[]> headers) returns error?Unsubscribe to message events
Parameters
- accountId string - Account to apply operations to
- url string - Callback URL of the webhook subscription to remove, as a plain URL. The connector URL-encodes it
Return Type
- error? - The webhook subscription was deleted
listDripCampaigns
function listDripCampaigns(string accountId, map<string|string[]> headers, *ListDripCampaignsQueries queries) returns DripCampaignsResponse|errorFetch Account Drip Campaigns
Parameters
- accountId string - Account to apply operations to
- queries *ListDripCampaignsQueries - Queries to be sent with the request
Return Type
- DripCampaignsResponse|error - A page of drip campaigns
createDripCampaign
function createDripCampaign(string accountId, CreateUpdateDripCampaign payload, map<string|string[]> headers) returns DripCampaignResponse|errorCreate a Drip Campaign
Parameters
- accountId string - Account to apply operations to
- payload CreateUpdateDripCampaign - Drip campaign to create
Return Type
- DripCampaignResponse|error - The created drip campaign
getDripCampaign
function getDripCampaign(string accountId, string dripCampaignId, map<string|string[]> headers) returns DripCampaignResponse|errorFetch a drip campaign
Parameters
- accountId string - Account to apply operations to
- dripCampaignId string - Drip Campaign to apply operations to
Return Type
- DripCampaignResponse|error - The requested drip campaign
updateDripCampaign
function updateDripCampaign(string accountId, string dripCampaignId, CreateUpdateDripCampaign payload, map<string|string[]> headers) returns DripCampaignResponse|errorEdit a Drip Campaign
Parameters
- accountId string - Account to apply operations to
- dripCampaignId string - Drip Campaign to apply operations to
- payload CreateUpdateDripCampaign - Updated drip campaign
Return Type
- DripCampaignResponse|error - The updated drip campaign
deleteDripCampaign
function deleteDripCampaign(string accountId, string dripCampaignId, map<string|string[]> headers) returns SuccessResponse|errorDeletes a drip campaign
Parameters
- accountId string - Account to apply operations to
- dripCampaignId string - Drip Campaign to apply operations to
Return Type
- SuccessResponse|error - Confirmation that the drip campaign was deleted
duplicateDripCampaign
function duplicateDripCampaign(string accountId, string dripCampaignId, map<string|string[]> headers) returns DripCampaignResponse|errorDuplicate a Drip Campaign
Parameters
- accountId string - Account to apply operations to
- dripCampaignId string - Drip Campaign to apply operations to
Return Type
- DripCampaignResponse|error - The new copy of the drip campaign
activateDripCampaign
function activateDripCampaign(string accountId, string dripCampaignId, map<string|string[]> headers) returns SuccessResponse|errorActivate a Drip Campaign
Parameters
- accountId string - Account to apply operations to
- dripCampaignId string - Drip Campaign to apply operations to
Return Type
- SuccessResponse|error - Confirmation that the drip campaign was activated
deactivateDripCampaign
function deactivateDripCampaign(string accountId, string dripCampaignId, map<string|string[]> headers) returns SuccessResponse|errorDeactivate a drip campaign
Parameters
- accountId string - Account to apply operations to
- dripCampaignId string - Drip Campaign to apply operations to
Return Type
- SuccessResponse|error - Confirmation that the drip campaign was deactivated
migrateDripCampaignToWorkflow
function migrateDripCampaignToWorkflow(string accountId, string dripCampaignId, map<string|string[]> headers) returns WorkflowResponse|errorTransform a drip campaign to a workflow
Parameters
- accountId string - Account to apply operations to
- dripCampaignId string - Drip Campaign to apply operations to
Return Type
- WorkflowResponse|error - The workflow created from the drip campaign
listDripCampaignExecutions
function listDripCampaignExecutions(string accountId, string dripCampaignId, map<string|string[]> headers, *ListDripCampaignExecutionsQueries queries) returns DripCampaignExecutionsResponse|errorFetch executions for dripcampaigns
Parameters
- accountId string - Account to apply operations to
- dripCampaignId string - Drip Campaign to apply operations to
- queries *ListDripCampaignExecutionsQueries - Queries to be sent with the request
Return Type
- DripCampaignExecutionsResponse|error - The executions of the drip campaign
Records
sakari.sms: ABTestNodeConfig
Configuration of a node that splits contacts between two paths for A/B testing
Fields
- split? decimal - How contacts are split between the two test paths
sakari.sms: AdvancedDelay
A delay with an initial duration and optional constraints on the days and time it ends
Fields
- additionalTime? AdvancedDelayAdditionalTime - Constraints on the days and time at which the delay ends
- initialDelay? Delay - A duration expressed in days, hours and minutes
sakari.sms: AdvancedDelayAdditionalTime
Constraints on the days and time at which the delay ends
Fields
- timezone? string - Time zone used for the day and time constraints
- days? AdvancedDelayDays - Days of the week on which a delayed step may continue
- time? AdvancedDelayTime - Time of day at which a delayed step continues
sakari.sms: AdvancedDelayTime
Time of day at which a delayed step continues
Fields
- hour decimal - Hour of the day
- minute decimal - Minute of the hour
sakari.sms: ApiError
An error reported by the API, with a code and a human-readable description
Fields
- code string - Code identifying the error
- description string - Human-readable description of the error
sakari.sms: Autoresponder
A rule that automatically replies to incoming messages matching a pattern
Fields
- scheduleType? "OOO"|"in office"|"custom" - When the autoresponder is active: out of office, in office or on a custom schedule
- advanced boolean(default false) - Whether advanced matching settings are used
- response string - Reply sent when an incoming message matches
- 'match string - Text or pattern that incoming messages are matched against
- customObject? record {} - Custom schedule settings used when the schedule type is custom
- id string - Unique identifier of the autoresponder
- group? string - Group whose incoming messages the autoresponder applies to
sakari.sms: AutoresponderRequest
Request payload for creating or updating an autoresponder
Fields
- scheduleType? "OOO"|"in office"|"custom" - When the autoresponder is active: out of office, in office or on a custom schedule
- advanced boolean(default false) - Whether advanced matching settings are used
- response string - Reply sent when an incoming message matches
- 'match string - Text or pattern that incoming messages are matched against
- customObject? record {} - Custom schedule settings used when the schedule type is custom
- group? string - Group whose incoming messages the autoresponder applies to
sakari.sms: AutoresponderResponse
Response containing a single autoresponder
Fields
- Fields Included from *BasicResponse
- success boolean
- anydata...
- data Autoresponder - A rule that automatically replies to incoming messages matching a pattern
sakari.sms: AutorespondersResponse
Paginated response containing a list of autoresponders
Fields
- Fields Included from *PaginatedResponse
- pagination Pagination
- success boolean
- anydata...
- data Autoresponder[] - The autoresponders in this page of results
sakari.sms: AvailablePhoneNumber
A phone number that is available to be added to the account
Fields
- country? string - Country of the phone number
- number? string - The available phone number
- features? string[] - Features supported by the phone number
- price? string - Price of the phone number
- 'type? string - Type of the phone number
sakari.sms: AvailablePhoneNumbersResponse
Response containing the phone numbers available to add to the account
Fields
- Fields Included from *BasicResponse
- success boolean
- anydata...
- data AvailablePhoneNumber[] - The available phone numbers
sakari.sms: Balance
The current balance of a Sakari account and the message segments it can pay for
Fields
- country string - Country used to price message segments
- balance decimal - Current account balance
- segmentPrice? decimal - Price of a single message segment
- segments decimal - Number of message segments the current balance can pay for
sakari.sms: BalanceResponse
Response containing the account balance
Fields
- Fields Included from *BasicResponse
- success boolean
- anydata...
- data? Balance - The current balance of a Sakari account and the message segments it can pay for
sakari.sms: BasicGroup
A group's identifier and name
Fields
- name string - Name of the group
- id string - Unique identifier of the group
sakari.sms: BasicResponse
Base envelope returned by every API call, indicating whether the request succeeded
Fields
- success boolean - Whether the request succeeded
sakari.sms: Campaign
A reusable message campaign with its contact filters, template, schedule and reporting settings
Fields
- template? string - Message template sent by the campaign
- paused? string - When the campaign was paused
- created? Updated - Audit information recording when and by whom a record was changed
- description? string - Description of the campaign
- fieldMappings? FieldMapping[] - Mappings from uploaded file columns to contact attributes
- filters? CampaignFilter - Criteria that select which contacts a campaign is sent to
- media? Media[] - List of media objects attached to message
- trigger? CampaignTrigger - How the campaign is triggered
- nextExecution? string - When the campaign is next due to run
- schedule? Schedule - When and how often a campaign runs
- phoneNumberFilter? CampaignPhoneNumberFilter - Selects the phone numbers the campaign is sent from
- lastJob? CampaignExecution - A single run of a campaign and its delivery results
- name string - Name of the campaign
- id string - Unique identifier of the campaign
- updated? Updated - Audit information recording when and by whom a record was changed
- reporting? CampaignReporting - Settings for reports sent after the campaign runs
sakari.sms: CampaignExecution
A single run of a campaign and its delivery results
Fields
- submitted decimal - Number of messages submitted
- failures decimal - Number of messages that failed
- price decimal - Total price of the execution
- created Updated - Audit information recording when and by whom a record was changed
- invalid record {}[] - Contacts that could not be sent to
- id string - Unique identifier of the execution
- status string - Status of the execution
sakari.sms: CampaignFilter
Criteria that select which contacts a campaign is sent to
Fields
- q? string - Search term that contacts must match
- attributes? Condition[] - Attribute conditions that contacts must meet
- tags? CampaignFilterTags[] - Tags used to select contacts
sakari.sms: CampaignFilters
Criteria that select the contacts the campaign is sent to
Fields
- attributes? string[] - Attribute conditions that contacts must meet to be included
- contacts? string[] - Contacts to include in the campaign
- tags? string[] - Tags that contacts must have to be included
sakari.sms: CampaignFilterTags
Fields
- visible? boolean - Whether the tag is visible
- tag string - The tag value
sakari.sms: CampaignPhoneNumberFilter
Selects the phone numbers the campaign is sent from
Fields
- group? CampaignPhoneNumberFilterGroup - Group whose phone numbers send the campaign
sakari.sms: CampaignPhoneNumberFilterGroup
Group whose phone numbers send the campaign
Fields
- id? string - Unique identifier of the group
sakari.sms: CampaignReporting
Settings for reports sent after the campaign runs
Fields
- unit? string - Unit of the report delay
- delay? string - How long after the campaign runs the report is sent
- destination string - Destination the report is sent to
- when? string - When a report is sent
sakari.sms: CampaignRequest
Request payload for creating a campaign
Fields
- template? string - Message template sent by the campaign
- trigger? CampaignRequestTrigger - How the campaign is triggered
- filters? CampaignFilters - Criteria that select the contacts the campaign is sent to
sakari.sms: CampaignRequestTrigger
How the campaign is triggered
Fields
- code? "M"|"S"|"FU"|"V2" - Campaign type specifies how it sources contacts and what event triggers its execution Sort order
M- ManualS- ScheduledFU- File UploadV2- V2
sakari.sms: CampaignResponse
Response containing a single campaign
Fields
- Fields Included from *BasicResponse
- success boolean
- anydata...
- data Campaign - A reusable message campaign with its contact filters, template, schedule and reporting settings
sakari.sms: CampaignsResponse
Paginated response containing a list of campaigns
Fields
- Fields Included from *PaginatedResponse
- pagination Pagination
- success boolean
- anydata...
- data Campaign[] - The campaigns in this page of results
sakari.sms: CampaignTrigger
How the campaign is triggered
Fields
- code? string - Code of the campaign trigger type
- name? string - Name of the campaign trigger type
sakari.sms: Channel
Base settings shared by every phone number channel
Fields
- active? boolean - Whether the channel is active
sakari.sms: ChoiceNodeConfig
Configuration of a node that branches on the value of a property
Fields
- property WorkflowDataReference - A reference to a value available within a workflow, such as a workflow property, a node output, a contact attribute or an event field
sakari.sms: Condition
A comparison applied to a contact attribute to filter contacts
Fields
- comparator string - Comparison operator to apply
- attribute string - Contact attribute to compare
sakari.sms: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth OAuth2ClientCredentialsGrantConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- cookieConfig? CookieConfig - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
sakari.sms: Contact
A contact in the Sakari address book
Fields
- Fields Included from *Person
- firstName string
- lastName string
- mobile InternationalNumber
- id string
- email string
- anydata...
- id string - Unique identifier of the contact
- valid? boolean - Whether the contact's details are valid
- activecampaign? Contact_activecampaign - Link to the matching ActiveCampaign record
- blocked? string - Date and time the contact was blocked
- lists? ContactList[] - Lists the contact belongs to
- created? Updated - Audit information recording when and by whom a record was changed
- optIn? string - Date and time the contact opted in to messages
- pipedrive? Contact_pipedrive - Link to the matching Pipedrive record
- attributes? record {} - Custom attributes of the contact
- 'error? ApiError - An error reported by the API, with a code and a human-readable description
- hubspot? Contact_hubspot - Link to the matching HubSpot record
- updated? Updated - Audit information recording when and by whom a record was changed
sakari.sms: Contact_activecampaign
Link to the matching ActiveCampaign record
Fields
- id? decimal - ID of the contact in ActiveCampaign.
sakari.sms: Contact_hubspot
Link to the matching HubSpot record
Fields
- id? decimal - ID of the contact in HubSpot.
sakari.sms: Contact_pipedrive
Link to the matching Pipedrive record
Fields
- id? decimal - ID of the contact in Pipedrive.
sakari.sms: ContactCreatedTriggerConfig
Configuration of a trigger that starts a workflow when a contact is created
sakari.sms: ContactFilter
Criteria that select contacts, used to define the members of a list
Fields
- valid? boolean - Whether to include only valid contacts
- q? string - Search term that contacts must match
- unblocked? boolean - Whether to include only unblocked contacts
- blocked? boolean - Whether to include only blocked contacts
- invalid? boolean - Whether to include only invalid contacts
- optIn? boolean - Whether to include only contacts that have opted in
- attributes? Condition[] - Attribute conditions that contacts must meet
- list? string - ID of a list that contacts must belong to
sakari.sms: ContactList
A list that a contact belongs to, with the contact's opt-in and opt-out dates for that list
Fields
- Fields Included from *List
- filter ContactFilter
- optInConfirmation string
- doubleOptIn ListDoubleOptIn
- name string
- id string
- source ListSource
- keyword string
- anydata...
- optOut? string - Date and time the contact opted out of the list
- optIn? string - Date and time the contact opted in to the list
sakari.sms: ContactRequest
Request payload that identifies or describes a contact: its name, email, mobile number and custom attributes, or the ID of an existing contact
Fields
- Fields Included from *Person
- firstName string
- lastName string
- mobile InternationalNumber
- id string
- email string
- anydata...
- attributes? record {} - Custom attributes of the contact
sakari.sms: ContactResponse
Response containing a single contact
Fields
- Fields Included from *BasicResponse
- success boolean
- anydata...
- data Contact - A contact in the Sakari address book
sakari.sms: ContactsResponse
Paginated response containing a list of contacts
Fields
- Fields Included from *PaginatedResponse
- pagination Pagination
- success boolean
- anydata...
- data Contact[] - The contacts in this page of results
sakari.sms: ContactUpdate
A value to set on a contact property
Fields
- property? Property - A contact property that can be updated
- value? string - Value to set on the property
sakari.sms: ContactUpdatedTriggerConfig
Configuration of a trigger that starts a workflow when a contact is updated
Fields
- condition? WorkflowCondition - A comparison applied to a workflow data reference
sakari.sms: ContactUploadResponse
Response summarising the result of a contact upload
Fields
- Fields Included from *BasicResponse
- success boolean
- anydata...
- data ContactUploadResponse_data - Summary of the contact upload
sakari.sms: ContactUploadResponse_data
Summary of the contact upload
Fields
- submitted? int - Number of contacts submitted.
- inserted? int - Number of contacts created.
- success? int - Number of contacts processed successfully.
- updated? int - Number of existing contacts updated.
- contacts? Contact[] - Uploaded contacts
- errors? Contact[] - Contacts that failed validation
sakari.sms: Conversation
A message thread between the account and a single contact
Fields
- phoneNumber? PhoneNumber - A phone number used by the account to send and receive messages
- unread? string[] - Identifiers that track unread messages in the conversation
- created? Updated - Audit information recording when and by whom a record was changed
- contact? Contact - A contact in the Sakari address book
- lastMessage? Message - An SMS or MMS message sent to or received from a contact
- closed? string - Date and time the conversation was closed
- id? string - Unique identifier of the conversation
- 'type? string - Type of the conversation
- updated? Updated - Audit information recording when and by whom a record was changed
- group? BasicGroup - A group's identifier and name
sakari.sms: ConversationResponse
Response containing a single conversation
Fields
- Fields Included from *BasicResponse
- success boolean
- anydata...
- data Conversation - A message thread between the account and a single contact
sakari.sms: ConversationsResponse
Paginated response containing a list of conversations
Fields
- Fields Included from *PaginatedResponse
- pagination Pagination
- success boolean
- anydata...
- data Conversation[] - The conversations in this page of results
sakari.sms: CreateContactQueries
Represents the Queries record for the operation: createContact
Fields
- mergeStrategy? "append"|"core"|"remove" - Determines how existing contacts with matching mobile numbers are treated
sakari.sms: CreateUpdateDripCampaign
Request payload for creating or updating a drip campaign
Fields
- Fields Included from *DripCampaign
- stats DripCampaignStats
- created Updated
- name string
- description string
- messages DripCampaignMessage[]
- active boolean
- id string
- trigger DripCampaignTrigger
- updated Updated
- maxDuration decimal
- anydata...
- activate? boolean - Whether to activate the drip campaign after saving it
sakari.sms: Delay
A duration expressed in days, hours and minutes
Fields
- hours decimal - Number of hours
- minutes decimal - Number of minutes
- days decimal - Number of days
sakari.sms: DelayNodeConfig
Configuration of a node that waits before continuing
Fields
- delay? AdvancedDelay - A delay with an initial duration and optional constraints on the days and time it ends
sakari.sms: DripCampaign
A drip campaign that sends a sequence of timed messages to contacts after a trigger event
Fields
- stats? DripCampaignStats - Contact counts that summarise the progress of a drip campaign or one of its messages
- created? Updated - Audit information recording when and by whom a record was changed
- name string - Name of the drip campaign
- description? string - Description of the drip campaign
- messages DripCampaignMessage[] - Messages sent by the drip campaign, in order
- active? boolean - Whether the drip campaign is active
- id? string - Unique identifier of the drip campaign
- trigger DripCampaignTrigger - Event that enrols contacts in the drip campaign
- updated? Updated - Audit information recording when and by whom a record was changed
- maxDuration? decimal - Maximum duration of the drip campaign
sakari.sms: DripCampaignExecution
A contact's progress through a drip campaign
Fields
- contact? Contact - A contact in the Sakari address book
- id string - Unique identifier of the execution
- entered string - Date and time the contact entered the drip campaign
- status string - Status of the contact in the drip campaign
sakari.sms: DripCampaignExecutionsResponse
Response containing drip campaign executions
Fields
- Fields Included from *BasicResponse
- success boolean
- anydata...
- data DripCampaignExecution[] - The drip campaign executions
sakari.sms: DripCampaignMessage
A message sent as one step of a drip campaign, after a delay
Fields
- delay Delay - A duration expressed in days, hours and minutes
- stats? DripCampaignStats - Contact counts that summarise the progress of a drip campaign or one of its messages
- id? string - Unique identifier of the drip campaign message
- media? Media[] - Media files attached to the message
- message string - Text of the message
sakari.sms: DripCampaignResponse
Response containing a single drip campaign
Fields
- Fields Included from *BasicResponse
- success boolean
- anydata...
- data DripCampaign - A drip campaign that sends a sequence of timed messages to contacts after a trigger event
sakari.sms: DripCampaignsResponse
Paginated response containing a list of drip campaigns
Fields
- Fields Included from *PaginatedResponse
- pagination Pagination
- success boolean
- anydata...
- data DripCampaign[] - The drip campaigns in this page of results
sakari.sms: DripCampaignStats
Contact counts that summarise the progress of a drip campaign or one of its messages
Fields
- engaged? decimal - Number of contacts that engaged
- optOut? decimal - Number of contacts that opted out
- active? decimal - Number of contacts currently active
- entered? decimal - Number of contacts that have entered
- noAction? decimal - Number of contacts that took no action
- errored? decimal - Number of contacts that encountered an error
sakari.sms: DripCampaignTrigger
Event that enrols contacts in the drip campaign
Fields
- delay Delay - A duration expressed in days, hours and minutes
- groups? Group[] - Groups whose events trigger the drip campaign
- 'type string - Type of the trigger event
- message? string - Message text that triggers the drip campaign when received
- list? List - A list of contacts
- group? Group - A group of phone numbers, senders and users that send and receive messages together
sakari.sms: EdgeValidation
Rules for an outgoing edge of a workflow node type
Fields
- defaultEdge? boolean - Whether this is the default edge
- multiple? boolean - Whether multiple edges of this type are allowed
- 'type? "timeout"|"standard"|"error" - Type of the edge
- value? EdgeValidationValue - Rules for the edge's value
sakari.sms: EdgeValidationValue
Rules for the edge's value
Fields
- editable? boolean - Whether the value can be edited
- mandatory? boolean - Whether a value is required
sakari.sms: FieldMapping
Maps a column of an uploaded file to a contact attribute
Fields
- column? string - Column in the uploaded file
- attribute? string - Contact attribute the column maps to
- mandatory? boolean - Whether the column must have a value
sakari.sms: FilterNodeConfig
Configuration of a node that lets only contacts matching its conditions continue
Fields
- conditions? WorkflowCondition[] - Conditions a contact must meet to continue
sakari.sms: Form
A web form that collects contact sign-ups
Fields
- conversions decimal - Number of times the form was submitted
- created? Updated - Audit information recording when and by whom a record was changed
- name string - Name of the form
- active? string - Date and time the form was activated
- id string - Unique identifier of the form
- impressions decimal - Number of times the form was viewed
- updated? Updated - Audit information recording when and by whom a record was changed
sakari.sms: FormSubmittedTriggerConfig
Configuration of a trigger that starts a workflow when a form is submitted
Fields
- form? Form - A web form that collects contact sign-ups
sakari.sms: GoogleSheet
A Google Sheets spreadsheet used by a workflow node
Fields
- tab? GoogleSheetTab - A tab in a Google Sheets spreadsheet
- name? string - Name of the spreadsheet
- tabs? GoogleSheetTab[] - Tabs in the spreadsheet
- connection? UserIntegration - A user's connection to a third-party integration
- id? string - Unique identifier of the spreadsheet
sakari.sms: GoogleSheetColumn
A column in a Google Sheets tab
Fields
- name string - Name of the column
- index decimal - Position of the column
sakari.sms: GoogleSheetColumnMapping
Maps a value to a column in a Google Sheets tab
Fields
- column? GoogleSheetColumn - A column in a Google Sheets tab
- value? string - Value written to the column
sakari.sms: GoogleSheetsExportNodeConfig
Configuration of a node that writes values to a Google Sheets spreadsheet
Fields
- googlesheet? GoogleSheet - A Google Sheets spreadsheet used by a workflow node
- userId? string - ID of the user whose integration is used
- properties? GoogleSheetColumnMapping[] - Values to write to each column
sakari.sms: GoogleSheetsLookupNodeConfig
Configuration of a node that looks up a value in a Google Sheets spreadsheet
Fields
- outputColumn? GoogleSheetColumn - A column in a Google Sheets tab
- googlesheet? GoogleSheet - A Google Sheets spreadsheet used by a workflow node
- searchColumn? GoogleSheetColumn - A column in a Google Sheets tab
- searchValue? string - Value to search for
- userId? string - ID of the user whose integration is used
sakari.sms: GoogleSheetTab
A tab in a Google Sheets spreadsheet
Fields
- name? string - Name of the tab
- id? decimal - Unique identifier of the tab
sakari.sms: Group
A group of phone numbers, senders and users that send and receive messages together
Fields
- Fields Included from *BasicGroup
- isDefault? boolean - Whether this is the account's default group
- useSharedPool? boolean - Whether the group sends from the shared phone number pool
- name? string - Name of the group
- officeHours? GroupOfficeHours - Office hours configured for a group
- id? string - Unique identifier of the group
- senders? Sender[] - Senders assigned to the group
- phoneNumbers? PhoneNumber[] - Phone numbers assigned to the group
- notifications? GroupNotification[] - Notification destinations configured for the group
- users? User[] - Users who belong to the group
- tags? string[] - Tags assigned to the group
sakari.sms: GroupNotification
A notification destination configured for a group
Fields
- destination? GroupNotificationDestination - Destination that receives the notification
- integration? string - Integration used to deliver the notification
- group? BasicGroup - A group's identifier and name
sakari.sms: GroupNotificationDestination
Destination that receives the notification
Fields
- name string - Name of the destination
- id string - Unique identifier of the destination
sakari.sms: GroupOfficeHours
Office hours configured for a group
Fields
- times? Times - Weekly schedule of time ranges, listed per day of the week
- timezone? string - Time zone of the office hours
- active? boolean - Whether office hours are enabled
sakari.sms: Hours
A time range within a day, with a start and an end time
Fields
- 'start Time - A time of day expressed as an hour and minute
- end Time - A time of day expressed as an hour and minute
sakari.sms: IfThenNodeConfig
Configuration of a node that branches depending on whether its conditions are met
Fields
- conditions? WorkflowCondition[] - Conditions that decide which branch is followed
sakari.sms: IncrDecrementNodeConfig
Configuration of a node that increments or decrements a numeric property
Fields
- property string - Name of the property to change
- operation? "add"|"subtract" - Whether to add to or subtract from the property
- value decimal - Amount to add or subtract
sakari.sms: InternationalNumber
A phone number together with its country and validation details
Fields
- valid? boolean - Whether the phone number is valid
- country string - Country code of the phone number
- number string - The phone number
- lineType? string - Line type of the phone number, such as mobile
- verified? string - Date and time the phone number was verified
sakari.sms: Link
A tracked short link that records clicks on a destination URL
Fields
- contactTracking? boolean - Whether clicks are tracked per contact
- shortenedUrl string - Shortened URL of the link
- stats? LinkStats - Click statistics for the link
- sourceTracking? boolean - Whether clicks are tracked per source
- created? Updated - Audit information recording when and by whom a record was changed
- domain? LinkDomain - Domain used for the shortened URL
- name? string - Name of the link
- keyId string - Key that identifies the link in its shortened URL
- id? string - Unique identifier of the link
- destinationUrl string - URL the link redirects to
- updated? Updated - Audit information recording when and by whom a record was changed
sakari.sms: LinkClickedNodeConfig
Configuration of a node that waits for a tracked link to be clicked
Fields
- link? Link - A tracked short link that records clicks on a destination URL
- timeout? Delay - A duration expressed in days, hours and minutes
sakari.sms: LinkClickedTriggerConfig
Configuration of a trigger that starts a workflow when a tracked link is clicked
Fields
- link? Link - A tracked short link that records clicks on a destination URL
sakari.sms: LinkDomain
Domain used for the shortened URL
Fields
- name? string - Name of the domain
- id? string - Unique identifier of the domain
sakari.sms: LinkResponse
Response containing a single tracked link
Fields
- Fields Included from *BasicResponse
- success boolean
- anydata...
- data Link - A tracked short link that records clicks on a destination URL
sakari.sms: LinkSource
A source of clicks on a tracked link, with its click statistics
Fields
- stats LinkSourceStats - Click statistics for the link source
- name string - Name of the link source
- id? string - Unique identifier of the link source
sakari.sms: LinkSourceResponse
Response containing a single click source of a tracked link
Fields
- Fields Included from *BasicResponse
- success boolean
- anydata...
- data LinkSource - A source of clicks on a tracked link, with its click statistics
sakari.sms: LinkSourcesResponse
Paginated response containing the click sources of a tracked link
Fields
- Fields Included from *PaginatedResponse
- pagination Pagination
- success boolean
- anydata...
- data LinkSource[] - The link sources in this page of results
sakari.sms: LinkSourceStat
Click count for a tracked link source on a given date
Fields
- date string - Date the statistic applies to
- value decimal - Number of clicks on that date
sakari.sms: LinkSourceStats
Click statistics for the link source
Fields
- ctr? decimal - Click-through rate
- totalClicks? decimal - Total number of clicks recorded
- uniqueClicks? decimal - Number of unique clicks recorded
sakari.sms: LinkSourceStatsResponse
Paginated response containing click statistics over time for a link source
Fields
- Fields Included from *PaginatedResponse
- pagination Pagination
- success boolean
- anydata...
- data LinkSourceStat[] - Click counts by date for the link source
sakari.sms: LinksResponse
Paginated response containing a list of tracked links
Fields
- Fields Included from *PaginatedResponse
- pagination Pagination
- success boolean
- anydata...
- data Link[] - The tracked links in this page of results
sakari.sms: LinkStats
Click statistics for the link
Fields
- ctr? decimal - Click-through rate
- totalClicks? decimal - Total number of clicks recorded
- uniqueClicks? decimal - Number of unique clicks recorded
sakari.sms: List
A list of contacts
Fields
- filter? ContactFilter - Criteria that select contacts, used to define the members of a list
- optInConfirmation? string - Message sent to confirm that a contact has joined the list
- doubleOptIn? ListDoubleOptIn - Double opt-in settings for the list
- name string - Name of the list
- id string - Unique identifier of the list
- 'source? ListSource - External source the list is synchronised from
- keyword? string - Keyword that contacts text to join the list
sakari.sms: ListAvailablePhoneNumbersQueries
Represents the Queries record for the operation: listAvailablePhoneNumbers
Fields
- country? string - Country in question
- features? string - Features for phone number
- contains? string - What should be in the string
- areaCode? string - Area Code for phone number
- postalCode? string - Postal code for Number
- 'type? string - Phone number type
sakari.sms: ListCampaignsQueries
Represents the Queries record for the operation: listCampaigns
Fields
- offset? int - Results to skip when paginating through a result set
- 'limit? int - Maximum number of results to return
- name? string - Filter by name or part of
sakari.sms: ListContactsQueries
Represents the Queries record for the operation: listContacts
Fields
- firstName? string - Filter by first name or part of
- lastName? string - Filter by last name or part of
- offset? int - Results to skip when paginating through a result set
- 'limit? int - Maximum number of results to return
- mobile? string - Filter by mobile or part of
- email? string - Filter by email or part of
- tags? string - Filter by tag(s)
sakari.sms: ListConversationsQueries
Represents the Queries record for the operation: listConversations
Fields
- offset? int - Results to skip when paginating through a result set
- 'limit? int - Maximum number of results to return
sakari.sms: ListDoubleOptIn
Double opt-in settings for the list
Fields
- prompt? string - Message asking the contact to confirm the opt-in
- enabled? boolean - Whether double opt-in is required to join the list
sakari.sms: ListDripCampaignExecutionsQueries
Represents the Queries record for the operation: listDripCampaignExecutions
Fields
- versionId? string - versionId of the desired Workflow Version
- offset? int - Results to skip when paginating through a result set
sakari.sms: ListDripCampaignsQueries
Represents the Queries record for the operation: listDripCampaigns
Fields
- offset? int - Results to skip when paginating through a result set
- 'limit? int - Maximum number of results to return
sakari.sms: ListLinkSourcesQueries
Represents the Queries record for the operation: listLinkSources
Fields
- sources? string - Sources to analyse
sakari.sms: ListLinksQueries
Represents the Queries record for the operation: listLinks
Fields
- q? string - General search term that searchs accross multiple fields
sakari.sms: ListMessagesQueries
Represents the Queries record for the operation: listMessages
Fields
- offset? int - Results to skip when paginating through a result set
- contactId? string - ID of contact
- conversationId? string - ID of conversation
- 'limit? int - Maximum number of results to return
sakari.sms: ListNodeConfig
Configuration of a node that acts on a contact's membership of a list
Fields
- contact? WorkflowDataReference - A reference to a value available within a workflow, such as a workflow property, a node output, a contact attribute or an event field
- list? List - A list of contacts
sakari.sms: ListSource
External source the list is synchronised from
Fields
- lastSynced? string - When the list was last synchronised
- integration string - Integration the list is synchronised from
- id string - ID of the list in the external source
sakari.sms: ListTemplatesQueries
Represents the Queries record for the operation: listTemplates
Fields
- offset? int - Results to skip when paginating through a result set
- 'limit? int - Maximum number of results to return
- name? string - Filter by name or part of
sakari.sms: ListTriggerConfig
Configuration of a trigger that starts a workflow based on membership of a contact list
Fields
- list? List - A list of contacts
sakari.sms: Media
A media file attached to a message
Fields
- filename? string - File name of the media file
- name? string - Display name of the media file
- 'type? string - Content type of the media file
- url? string - URL of the media file
sakari.sms: Message
An SMS or MMS message sent to or received from a contact
Fields
- template? string - Template used to generate the message
- outgoing? boolean - Whether the message was sent by the account rather than received
- read? boolean - Whether the message has been read
- created Updated - Audit information recording when and by whom a record was changed
- media? Media[] - List of media objects attached to message
- 'type? string - Type of the message, such as SMS or MMS
- message? string - Text of the message
- 'error? ApiError - An error reported by the API, with a code and a human-readable description
- segments? decimal - Number of segments the message was split into
- phoneNumber? string - Account phone number used for the message
- price? decimal - Price charged for the message
- contact? Contact - A contact in the Sakari address book
- id string - Unique identifier of the message
- sendAt? string - Date and time the message is scheduled to be sent
- updated? Updated - Audit information recording when and by whom a record was changed
- conversation? Conversation - A message thread between the account and a single contact
- group? Group - A group of phone numbers, senders and users that send and receive messages together
- status string - Delivery status of the message
sakari.sms: MessageReceivedNodeConfig
Configuration of a node that waits for a reply message
Fields
- timeout? Delay - A duration expressed in days, hours and minutes
- group? Group - A group of phone numbers, senders and users that send and receive messages together
sakari.sms: MessageReceivedTriggerConfig
Configuration of a trigger that starts a workflow when a message is received
Fields
- groups? Group[] - Groups whose received messages trigger the workflow
- message? string - Message text that triggers the workflow
sakari.sms: MessageResponse
Response containing a single message
Fields
- Fields Included from *BasicResponse
- success boolean
- anydata...
- data Message - An SMS or MMS message sent to or received from a contact
sakari.sms: MessagesResponse
Paginated response containing a list of messages
Fields
- Fields Included from *PaginatedResponse
- pagination Pagination
- success boolean
- anydata...
- data Message[] - The messages in this page of results
sakari.sms: MessageStatusTriggerConfig
Configuration of a trigger that starts a workflow when a message reaches a given status
Fields
- errors? ApiError[] - Message errors that trigger the workflow
- status? "sent"|"error" - Message status that triggers the workflow
sakari.sms: OAuth2ClientCredentialsGrantConfig
OAuth2 Client Credentials Grant Configs
Fields
- Fields Included from *OAuth2ClientCredentialsGrantConfig
- tokenUrl string(default "https://api.sakari.io/oauth2/token") - Token URL
sakari.sms: PaginatedResponse
Base envelope for list results, adding pagination details to the basic response
Fields
- Fields Included from *BasicResponse
- success boolean
- anydata...
- pagination Pagination - Paging details for a list result
sakari.sms: Pagination
Paging details for a list result
Fields
- offset int - Number of results skipped before this page
- 'limit int - Maximum number of results returned in this page
- hasNext boolean - Whether more results are available after this page
sakari.sms: Person
Basic details of a person, such as a contact or a user
Fields
- firstName? string - First name of the person
- lastName? string - Last name of the person
- mobile? InternationalNumber - A phone number together with its country and validation details
- id? string - Unique identifier of the person
- email? string - Email address of the person
sakari.sms: PhoneNumber
A phone number used by the account to send and receive messages
Fields
- country string - Country of the phone number
- verified? boolean - Whether the phone number has been verified
- groups? BasicGroup[] - Groups the phone number is assigned to
- forwardTo? record {} - Settings for forwarding to another number
- 'type string - Type of the phone number
- hosted? boolean - Whether the phone number is a hosted number, text-enabled while remaining with another carrier
- number string - The phone number
- channels? PhoneNumberChannels - The SMS, voice and WhatsApp channels configured for a phone number or sender
- provider? string - Provider of the phone number
- name? string - Display name of the phone number
- universalReply? boolean - Whether universal reply is enabled for the phone number
- id string - Unique identifier of the phone number
- supportedDestinations? string[] - Destination countries the phone number can send to
- status string - Status of the phone number
sakari.sms: PhoneNumberChannels
The SMS, voice and WhatsApp channels configured for a phone number or sender
Fields
- voice? VoiceChannel - Voice channel settings for a phone number or sender
- whatsapp? WhatsappChannel - WhatsApp channel settings for a phone number or sender
- sms? SmsChannel - SMS channel settings for a phone number or sender
sakari.sms: Property
A contact property that can be updated
Fields
- dataType? DataType - Data type of a property value
- name? string - Name of the property
- label? string - Display label of the property
sakari.sms: QuickCampaignRequest
Request payload for creating a campaign and executing it immediately or at a scheduled time
Fields
- listId string - ID of the contact list the campaign is sent to
- groupId string - ID of the group that sends the campaign messages
- name string - Name of the campaign
- sendAt? string - Date and time at which to send the campaign
- message QuickCampaignRequestMessage - Message content sent by the campaign
sakari.sms: QuickCampaignRequestMessage
Message content sent by the campaign
Fields
- media? Media[] - Media files attached to the message
- message? string - Text of the message
sakari.sms: QuickCampaignResponse
Response containing a newly created campaign and its execution
Fields
- Fields Included from *BasicResponse
- success boolean
- anydata...
- data QuickCampaignResponse_data - The created campaign and its execution
sakari.sms: QuickCampaignResponse_data
The created campaign and its execution
Fields
- campaign? Campaign - A reusable message campaign with its contact filters, template, schedule and reporting settings
- job? CampaignExecution - A single run of a campaign and its delivery results
sakari.sms: Schedule
When and how often a campaign runs
Fields
- cron? string - Cron expression defining when the campaign runs
- timezone? string - Time zone in which the schedule is evaluated
- frequency "OD"|"O"|"D"|"M" - Code for how often the campaign runs
sakari.sms: SelectOption
An option offered for a selectable workflow node property
Fields
- label? string - Display label of the option
- value? string - Value of the option
sakari.sms: Sender
A sender identity, such as a phone number, used to send messages
Fields
- identifier string - Identifier of the sender, such as the phone number
- channels? PhoneNumberChannels - The SMS, voice and WhatsApp channels configured for a phone number or sender
- created Updated - Audit information recording when and by whom a record was changed
- groups? BasicGroup[] - Groups the sender is assigned to
- subType string - Subtype of the sender
- id string - Unique identifier of the sender
- 'type "phonenumber" - Type of the sender
- updated Updated - Audit information recording when and by whom a record was changed
- status string - Status of the sender
sakari.sms: SendMessageNodeConfig
Configuration of a node that sends a message
Fields
- 'from? SendMessageNodeConfigFrom - Sender of the message
- to? SendMessageNodeConfigTo - Recipient of the message
- message? SendMessageNodeConfigMessage - Content of the message
sakari.sms: SendMessageNodeConfigFrom
Sender of the message
Fields
- custom? string - Custom sender the message is sent from
- 'type "group"|"custom" - Whether the message is sent from a group or a custom sender
- group? Group - A group of phone numbers, senders and users that send and receive messages together
sakari.sms: SendMessageNodeConfigMessage
Content of the message
Fields
- media? Media[] - List of media objects attached to message
- message? string - Text of the message
sakari.sms: SendMessageNodeConfigTo
Recipient of the message
Fields
- contact? WorkflowDataReference - A reference to a value available within a workflow, such as a workflow property, a node output, a contact attribute or an event field
- mobile? InternationalNumber - A phone number together with its country and validation details
- 'type? SendMessageToType - Type of recipient a workflow message is sent to
- user? User - A user of the Sakari account
- group? Group - A group of phone numbers, senders and users that send and receive messages together
sakari.sms: SendMessagesRequest
Request payload for sending a message to contacts, conversations or a filtered set of contacts
Fields
- template? string - Message text to send, which may include contact attribute placeholders
- phoneNumberFilter? SendMessagesRequestPhoneNumberFilter - Selects the phone numbers the message is sent from
- filters? SendMessagesRequestFilters - Criteria that select contacts to send the message to
- media? SendMessagesRequestMedia[] - List of media objects to attach to message
- 'type? "SMS"|"MMS" - Type of message to send
- conversations? string[] - List of conversation ids to send messages to
- contacts? ContactRequest[] - Contacts to send the message to
sakari.sms: SendMessagesRequestFilters
Criteria that select contacts to send the message to
Fields
- attributes? record {}[] - Attribute conditions that contacts must meet
- tags? string[] - Tags that contacts must have
sakari.sms: SendMessagesRequestMedia
Fields
- url? string - URL of the media file
sakari.sms: SendMessagesRequestPhoneNumberFilter
Selects the phone numbers the message is sent from
Fields
- group? SendMessagesRequestPhoneNumberFilterGroup - Group whose phone numbers send the message
sakari.sms: SendMessagesRequestPhoneNumberFilterGroup
Group whose phone numbers send the message
Fields
- id? string - Unique identifier of the group
sakari.sms: SendMessagesResponse
Response summarising a request to send messages
Fields
- Fields Included from *BasicResponse
- success boolean
- anydata...
- data SendMessagesResponse_data - Summary of the send request
sakari.sms: SendMessagesResponse_data
Summary of the send request
Fields
- valid? int - Number of valid recipients.
- jobId? string - ID of the job that sends the messages.
- requested? int - Number of recipients requested.
- estimatedPrice? decimal - Estimated total price of the messages.
- invalid? Contact[] - Contacts that could not be sent to.
- messages? Message[] - Messages created by the request.
sakari.sms: SetWorkflowPropertyNodeConfig
Configuration of a node that sets a workflow property to a value
Fields
- property string - Name of the workflow property to set
sakari.sms: ShareFileResponse
Response containing the short link to a shared file
Fields
- Fields Included from *BasicResponse
- success boolean
- anydata...
- data ShareFileResponse_data - Details of the shared file
sakari.sms: ShareFileResponse_data
Details of the shared file
Fields
- expires? string - Date and time the link expires.
- link string - Short link to the shared file.
sakari.sms: SmsChannel
SMS channel settings for a phone number or sender
Fields
- Fields Included from *Channel
- active boolean
- anydata...
- regulatory? SmsRegulatory - Carrier registration details for sending SMS from a phone number
- universalReply? boolean - Whether universal reply is enabled for the SMS channel
- supportedDestinations? SupportedDestinations - Map of destination countries to whether messages can be sent to them
sakari.sms: SmsRegulatory
Carrier registration details for sending SMS from a phone number
Fields
- approved? string - Date and time the registration was approved
- submitted? string - Date and time the registration was submitted
- rejected? string - Date and time the registration was rejected
- campaign? SmsRegulatoryCampaign - Registered messaging campaign
- brandStatus? string - Registration status of the brand
- pft? boolean - PFT flag of the SMS registration
sakari.sms: SmsRegulatoryCampaign
Registered messaging campaign
Fields
- useCase? string - Use case of the registered campaign
- campaignId? string - Campaign ID assigned by the registry
- id? string - Unique identifier of the registered campaign
sakari.sms: SubscribeWebhookRequest
Fields
- eventTypes? ("contact-created"|"contact-updated"|"contact-removed"|"message-received"|"message-sent"|"message-status"|"conversation-started"|"contact-opt-out"|"contact-opt-in"|"list-opt-out"|"list-opt-in")[] -
- url string -
sakari.sms: SuccessResponse
Confirmation that the requested operation completed
Fields
- success? boolean - Whether the operation succeeded
sakari.sms: SupportedDestinations
Map of destination countries to whether messages can be sent to them
Fields
- boolean... - Rest field
sakari.sms: Template
A reusable message or web template
Fields
- template? string - Template text, which may include contact attribute placeholders
- created? Updated - Audit information recording when and by whom a record was changed
- name? string - Name of the template
- id? string - Unique identifier of the template
- media? Media[] - List of media objects attached to message
- 'type? TemplateType - Type of a template
- updated? Updated - Audit information recording when and by whom a record was changed
sakari.sms: TemplateResponse
Response containing a single template
Fields
- Fields Included from *BasicResponse
- success boolean
- anydata...
- data Template - A reusable message or web template
sakari.sms: TemplatesResponse
Paginated response containing a list of templates
Fields
- Fields Included from *PaginatedResponse
- pagination Pagination
- success boolean
- anydata...
- data Template[] - The templates in this page of results
sakari.sms: Time
A time of day expressed as an hour and minute
Fields
- hour decimal - Hour of the day
- minute decimal - Minute of the hour
sakari.sms: Times
Weekly schedule of time ranges, listed per day of the week
Fields
- thu? Hours[] - Time ranges on Thursday
- tue? Hours[] - Time ranges on Tuesday
- wed? Hours[] - Time ranges on Wednesday
- sat? Hours[] - Time ranges on Saturday
- fri? Hours[] - Time ranges on Friday
- sun? Hours[] - Time ranges on Sunday
- mon? Hours[] - Time ranges on Monday
sakari.sms: UpdateContactNodeConfig
Configuration of a node that updates contact properties
Fields
- contact? WorkflowDataReference - A reference to a value available within a workflow, such as a workflow property, a node output, a contact attribute or an event field
- updates? ContactUpdate[] - Property updates to apply to the contact
sakari.sms: Updated
Audit information recording when and by whom a record was changed
Fields
- at string - Date and time of the change
- 'by? UpdatedBy - The user or process that made a change to a record
sakari.sms: UpdatedBy
The user or process that made a change to a record
Fields
- firstName? string - First name of the user who made the change
- lastName? string - Last name of the user who made the change
- subSource? string - More specific source through which the change was made
- name? string - Full name of the user who made the change
- id? string - Unique identifier of the user who made the change
- 'source? string - Source through which the change was made
- email? string - Email address of the user who made the change
sakari.sms: User
A user of the Sakari account
Fields
- Fields Included from *Person
- firstName string
- lastName string
- mobile InternationalNumber
- id string
- email string
- anydata...
- id string - Unique identifier of the user
- email string - Email address of the user
- role "Administrator"|"CampaignManager"|"Sender"|"ReadOnly" - Role of the user in the account
- tacAccepted? string - Date and time the user accepted the terms and conditions
sakari.sms: UserIntegration
A user's connection to a third-party integration
Fields
- connectedAt string - Date and time the integration was connected
- id string - Unique identifier of the integration connection
- user UserIntegrationUser - User who connected the integration
sakari.sms: UserIntegrationUser
User who connected the integration
Fields
- id string - Unique identifier of the user
- email? string - Email address of the user
sakari.sms: VoiceChannel
Voice channel settings for a phone number or sender
Fields
- Fields Included from *Channel
- active boolean
- anydata...
- incoming? VoiceChannel_incoming - How incoming calls are handled
- features? string[] - Voice features enabled for the channel
sakari.sms: VoiceChannel_incoming
How incoming calls are handled
Fields
- transcribe? boolean - Whether voicemails are transcribed.
- action? "forward"|"voicemail" - Action taken for incoming calls.
- forwardTo? string - Phone number incoming calls are forwarded to.
- message? string - Message played to callers.
sakari.sms: Webhook
A subscription that notifies a destination URL when selected events occur
Fields
- destination string - URL notifications are sent to
- id? string - Unique identifier of the webhook
- 'type? string - Type of the webhook
- eventTypes EventType[] - Events the webhook is notified about
sakari.sms: WebhookResponse
Response containing a single webhook subscription
Fields
- Fields Included from *BasicResponse
- success boolean
- anydata...
- data Webhook - A subscription that notifies a destination URL when selected events occur
sakari.sms: WebhooksResponse
Paginated response containing a list of webhook subscriptions
Fields
- Fields Included from *PaginatedResponse
- pagination Pagination
- success boolean
- anydata...
- data Webhook[] - The webhook subscriptions in this page of results
sakari.sms: Workflow
An automated workflow and its versions
Fields
- versions? WorkflowVersion[] - Versions of the workflow
- created Updated - Audit information recording when and by whom a record was changed
- name string - Name of the workflow
- id string - Unique identifier of the workflow
- updated Updated - Audit information recording when and by whom a record was changed
sakari.sms: WorkflowCondition
A comparison applied to a workflow data reference
Fields
- comparator string - Comparison operator to apply
- attribute WorkflowDataReference - A reference to a value available within a workflow, such as a workflow property, a node output, a contact attribute or an event field
sakari.sms: WorkflowDataReference
A reference to a value available within a workflow, such as a workflow property, a node output, a contact attribute or an event field
Fields
- path? string - Path to the value within the referenced data
- name string - Name of the referenced value
- 'type "workflow"|"output"|"contact"|"event" - Kind of data referenced
- nodeId? string - ID of the node whose output is referenced
sakari.sms: WorkflowDefinition
The nodes, edges and properties that define a workflow version
Fields
- nodes WorkflowNode[] - Nodes in the workflow
- edges WorkflowEdge[] - Edges connecting the workflow nodes
- properties? WorkflowProperties - Properties declared on a workflow
sakari.sms: WorkflowEdge
A connection from one workflow node to another
Fields
- id string - Unique identifier of the edge
- 'source string - ID of the node the edge starts from
- 'type WorkflowEdgeType - Type of an edge connecting two workflow nodes
- target? string - ID of the node the edge leads to
sakari.sms: WorkflowNode
A trigger or action step in a workflow
Fields
- id string - Unique identifier of the node
- 'type WorkflowNodeType - A type of node that can be used in a workflow
- config WorkflowNodeConfig - Configuration of a workflow node, whose shape depends on the node type
sakari.sms: WorkflowNodeProperty
A configurable property of a workflow node type
Fields
- Fields Included from *WorkflowNodePropertyBaseObject
- name string - Name of the property
- conditions? WorkflowNodePropertyCondition[] - Conditions that control when the property applies
sakari.sms: WorkflowNodePropertyBaseObject
Base settings shared by workflow node properties
Fields
- args? string[] - Additional arguments for the input control
- min? decimal - Minimum allowed value
- max? decimal - Maximum allowed value
- link? string - URL of further information about the property
- options? SelectOption[] - Options that can be selected for the property
- label? string - Display label of the property
- 'type WorkflowNodePropertyType - Input control type used to edit a workflow node property
- helperText? string - Help text shown for the property
- mandatory? boolean - Whether the property must be set
sakari.sms: WorkflowNodePropertyCondition
A condition on another property that controls when a workflow node property applies
Fields
- comparator string - Comparison operator to apply
- property string - Name of the property to check
- value string - Value to compare against
sakari.sms: WorkflowNodeType
A type of node that can be used in a workflow
Fields
- outputs? WorkflowNodeTypeOutput[] - Values the node type produces
- color? string - Display color of the node type
- icon? string - Icon of the node type
- description? string - Description of the node type
- supportsReenrollment? boolean - Whether contacts can enter the node more than once
- label? string - Display label of the node type
- 'type string - Kind of the node type, such as trigger or action
- supportLink? string - URL of support documentation for the node type
- name string - Name of the node type
- id string - Unique identifier of the node type
- properties? WorkflowNodeProperty[] - Configurable properties of the node type
- validation? WorkflowNodeTypeValidation - Rules for the outgoing edges a workflow node type must have
- status? string - Availability status of the node type
sakari.sms: WorkflowNodeTypeOutput
A value that a workflow node type produces for later nodes
Fields
- path string - Path to the output value
- default? boolean - Whether this is the default output
- dataType WorkflowNodeTypeOutputDataType - Data type of a workflow node output
- name string - Name of the output
sakari.sms: WorkflowNodeTypeValidation
Rules for the outgoing edges a workflow node type must have
Fields
- numEdges? decimal - Required number of edges
- edges? EdgeValidation[] - Rules for each outgoing edge
- numEdgeCondition? NumEdgeConditions - How the number of edges is compared with the required count
sakari.sms: WorkflowProperty
A named property that holds a value while a workflow runs
Fields
- created? WorkflowPropertyCreated - When the property was created
- dataType "string"|"number"|"boolean"|"date" - Data type of the property
- name string - Name of the property
sakari.sms: WorkflowPropertyCreated
When the property was created
Fields
- at? string - Date and time the property was created
sakari.sms: WorkflowResponse
Response containing a single workflow
Fields
- Fields Included from *BasicResponse
- success boolean
- anydata...
- data Workflow - An automated workflow and its versions
sakari.sms: WorkflowVersion
A version of a workflow and its definition
Fields
- 'readonly? boolean - Whether the version is read-only
- lastActive? string - Date and time the version was last active
- created Updated - Audit information recording when and by whom a record was changed
- name? string - Name of the version
- active? string - Date and time the version was activated
- definition WorkflowDefinition - The nodes, edges and properties that define a workflow version
- id string - Unique identifier of the version
- updated Updated - Audit information recording when and by whom a record was changed
Union types
sakari.sms: DataType
DataType
Data type of a property value
sakari.sms: NumEdgeConditions
NumEdgeConditions
How the number of edges is compared with the required count
sakari.sms: WorkflowNodePropertyType
WorkflowNodePropertyType
Input control type used to edit a workflow node property
sakari.sms: SendMessageToType
SendMessageToType
Type of recipient a workflow message is sent to
sakari.sms: DayOfWeek
DayOfWeek
Day of the week, from 0 for Sunday to 6 for Saturday
sakari.sms: CreateContactResponse
CreateContactResponse
The created contacts, or a summary of the uploaded contacts
sakari.sms: TemplateType
TemplateType
Type of a template
sakari.sms: WorkflowNodeConfig
WorkflowNodeConfig
Configuration of a workflow node, whose shape depends on the node type
sakari.sms: EventType
EventType
Type of event that a webhook can be notified about
sakari.sms: WorkflowNodeTypeOutputDataType
WorkflowNodeTypeOutputDataType
Data type of a workflow node output
sakari.sms: WorkflowEdgeType
WorkflowEdgeType
Type of an edge connecting two workflow nodes
Array types
sakari.sms: WorkflowProperties
WorkflowProperties
Properties declared on a workflow
sakari.sms: AdvancedDelayDays
AdvancedDelayDays
Days of the week on which a delayed step may continue
Simple name reference types
sakari.sms: WhatsappChannel
WhatsappChannel
WhatsApp channel settings for a phone number or sender
Import
import ballerinax/sakari.sms;Other versions
1.0.0
Metadata
Released date: 1 day ago
Version: 1.0.0
License: Apache-2.0
Security
Direct vulnerabilities: No known direct vulnerabilities
Indirect vulnerabilities:
Checked on 2026-11-21 via OSV.dev
Compatibility
Platform: any
Ballerina version: 2201.12.0
GraalVM compatible: Yes
Pull count
Total: 1
Current verison: 1
Weekly downloads
Keywords
Vendor/Sakari
Area/Communication
Type/Connector
Contributors